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.

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

Add a README.md #1

Closed
4 tasks done
frinyvonnick opened this issue Apr 25, 2017 · 4 comments
Closed
4 tasks done

Add a README.md #1

frinyvonnick opened this issue Apr 25, 2017 · 4 comments
Assignees
Milestone

Comments

@frinyvonnick
Copy link
Contributor

frinyvonnick commented Apr 25, 2017

  • Description and philosophy (fix in README.md #38)
  • Usage
  • Documentation
  • Contributing
  • Troubleshooting
  • Credits
@nlepage
Copy link
Member

nlepage commented Apr 25, 2017

Additionally I'd like to have a github.io page looking like lodash documentation

@nlepage nlepage added this to the 0.2-beta milestone Apr 28, 2017
@nlepage
Copy link
Member

nlepage commented Apr 28, 2017

see #12 for the documentation

@frinyvonnick frinyvonnick self-assigned this Jun 21, 2017
@nlepage
Copy link
Member

nlepage commented Jun 21, 2017

It would be nice to highlight that :

  • immutadot is mainly designed as a helper lib for redux
  • immutadot is largely based on lodash and lodash/fp

Also add simple examples with an es6 version and an immutadot version of the code and have a "Try in REPL" for each example based on runkit

@nlepage
Copy link
Member

nlepage commented Jun 23, 2017

In addition of the README, add a code of conduct and contributor guidelines.
See https://github.com/Zenika/immutadot/community

@nlepage nlepage self-assigned this Jul 4, 2017
@nlepage nlepage mentioned this issue Jul 4, 2017
4 tasks
This was referenced Jul 5, 2017
@nlepage nlepage closed this as completed Jul 6, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants