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

extend readme #10

Closed
altaywtf opened this issue Apr 25, 2016 · 2 comments
Closed

extend readme #10

altaywtf opened this issue Apr 25, 2016 · 2 comments

Comments

@altaywtf
Copy link
Contributor

No description provided.

@batuhan
Copy link
Contributor

batuhan commented Apr 27, 2016

About the readme, I think these titles would be just enough:

  • Packages we use (and why we use them for the ones that are not instantly obvious)
  • Installation and usage (ofc.)
  • People who helped making this (it's just a short list with @altayaydemir's name in it. We should't call this "Maintainers" 'cause of the next point)
  • A note that says we give no promises to maintain this starter
  • Explanation for the directory structure

Also, I don't think we need the note about the typings, anyone who writes TypeScript should be aware of that, no?

@altaywtf
Copy link
Contributor Author

I agree all of them, we should also note that Typescript that we wrote here is not the "most appropriate" way to use with React. However, we can (actually, we must) keep the codebase up-to-date as we become familiar with ts & react duo.

arnarp added a commit to arnarp/vortigern that referenced this issue Dec 14, 2016
arnarp added a commit to arnarp/vortigern that referenced this issue Dec 14, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants