Skip to content
This repository has been archived by the owner on Dec 1, 2023. It is now read-only.

Improve README (API documentation) #10

Closed
fraxken opened this issue Jan 14, 2023 · 2 comments · Fixed by #11
Closed

Improve README (API documentation) #10

fraxken opened this issue Jan 14, 2023 · 2 comments · Fixed by #11
Assignees
@Badrri-Narayanan
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@fraxken
Copy link
Member

fraxken commented Jan 14, 2023

Current README is lacking documentation and examples for the library methods. Could be cool if someone can contribute to add description and examples for each method.
@fraxken fraxken added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 14, 2023
@fraxken fraxken changed the title Improve README Improve README (API documentation) Jan 14, 2023
@Badrri-Narayanan
Copy link
Contributor

Hi @fraxken , can you please assign me this task?

@fraxken
Copy link
Member Author

fraxken commented Jan 14, 2023

@Badrri-Narayanan done 👍

@Badrri-Narayanan Badrri-Narayanan mentioned this issue Jan 15, 2023
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@Badrri-Narayanan Badrri-Narayanan

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
2 participants
@fraxken @Badrri-Narayanan