Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add basic usage examples and documentation #102

Open
gfcittolin opened this issue Apr 30, 2020 · 0 comments
Open

Add basic usage examples and documentation #102

gfcittolin opened this issue Apr 30, 2020 · 0 comments
Labels
enhancement
Milestone
v1.0

Comments

@gfcittolin
Copy link
Collaborator

The README.md of the next branch is still the old one. We should replace it with a new one with basic features and usage samples.
For a in-depth documentation, we should add and link the JSDoc generated files. Need to check which format of output should we use (html? markdown?)
@gfcittolin gfcittolin added this to the v1.0 milestone Apr 30, 2020
gfcittolin pushed a commit that referenced this issue Apr 30, 2020
Updates documentation
b15448b 
Tracked by #102
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
v1.0
Development

No branches or pull requests
1 participant
@gfcittolin