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

Update Readme.md #175

Open
obitodarky opened this issue Oct 2, 2019 · 2 comments
Open

Update Readme.md #175

obitodarky opened this issue Oct 2, 2019 · 2 comments
Labels
docs needed future help wanted

Comments

@obitodarky
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Currently, Readme.MD does not seem to be updated and looks very confusing for new contributors as there are a lot of things that seem to be missing.

Describe the solution you'd like
The Readme.MD should be updated with the following points to be kept in mind:

  • Describe Xcode and Swift versions used in the project
  • Have a table of contents
  • Have a getting started basic guideline (Guides on Xcode, CocoaPods and project installation and how to test them)
  • Have a different file for Contributing.MD and reference it in Readme.MD
@obitodarky
Copy link
Contributor Author

@benhalpern I would like to work on this issue!

@jessleenyc
Copy link
Contributor

@obitodarky go for it!

@triage-new-issues triage-new-issues bot removed the triage label Oct 2, 2019
@triage-new-issues triage-new-issues bot removed the triage label Oct 2, 2019
@weekly-digest weekly-digest bot mentioned this issue Oct 7, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs needed future help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jessleenyc @obitodarky