networkx / nx-parallel

A networkx backend that uses joblib to run graph algorithms in parallel.
BSD 3-Clause "New" or "Revised" License
24 stars 19 forks source link

Improve README for better clarity and understanding #15

Closed axif0 closed 11 months ago

axif0 commented 11 months ago

While going through the nx-parallel repository, I noticed that the README file could use a bit of sprucing up to make it even more helpful for newcomers.

These sections could be added and improved -

  1. Introduction
  2. Installation
  3. Usage
  4. Features
  5. Contribution
  6. Testing

I reckon these changes would make the README even better and more accessible to new users and contributors.