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

Update README #38

Open
0xRampey opened this issue Aug 25, 2017 · 4 comments
Open

Update README #38

0xRampey opened this issue Aug 25, 2017 · 4 comments

Comments

@0xRampey
Copy link
Member

Make README more informative and interesting.
Perhaps we can use this template: https://gist.github.com/prampey/aa67a1bfb7fae2d567be8b6cfa4e868e

@kaivalyar
Copy link
Member

https://www.gitbook.com/ can be good inspiration for writing a brief document summarising our project to make the job easier for future devs

@sharanry sharanry self-assigned this Sep 29, 2017
@sharanry
Copy link
Collaborator

So are we implementing the one in gist or gitbook?

@0xRampey
Copy link
Member Author

The Wiki can handle our current documentation. We'll migrate later to GitBook when the need arises.

@0xRampey
Copy link
Member Author

0xRampey commented Oct 3, 2017

Great job @sharanry !
I think it's better if we add a link to Wiki under the Contributing section. Also, this is an 'isomorphic web application'. I'll be making some changes.

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

3 participants