Skip to content
This repository has been archived by the owner on Oct 6, 2021. It is now read-only.

Update README file with instructions of use and fork #8

Open
gggodhwani opened this issue Feb 8, 2016 · 2 comments
Open

Update README file with instructions of use and fork #8

gggodhwani opened this issue Feb 8, 2016 · 2 comments
Assignees
@samarthbhargav
Labels
documentation task
Milestone
0.1

Comments

@gggodhwani
Copy link
Contributor

No description provided.

@gggodhwani gggodhwani changed the title Updated README file with instructions of use and fork Update README file with instructions of use and fork Feb 8, 2016
@samarthbhargav
Copy link
Contributor

@gggodhwani Can you explain this a bit? Didn't understand it. Maybe an example

@gggodhwani
Copy link
Contributor Author

Github Docs explains well how we should write a README file for the project.

I generally pick examples of good README from some of the trending projects like these:

  1. Twitter Emoji https://github.com/twitter/twemoji
  2. ES Entity Resolution https://github.com/YannBrrd/elasticsearch-entity-resolution
  3. CKAN https://github.com/ckan/ckan

@samarthbhargav samarthbhargav added this to the 0.1 milestone Feb 8, 2016
@samarthbhargav samarthbhargav self-assigned this Feb 8, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@samarthbhargav samarthbhargav

Labels
documentation task
Projects
None yet
Milestone
0.1
Development

No branches or pull requests
2 participants
@gggodhwani @samarthbhargav