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

Documentation: Add README template #1

Open
7 tasks
jeffh opened this issue Feb 28, 2016 · 0 comments
Open
7 tasks

Documentation: Add README template #1

jeffh opened this issue Feb 28, 2016 · 0 comments

Comments

@jeffh
Copy link
Collaborator

jeffh commented Feb 28, 2016

It would be super useful to provide a README template for swift libraries that includes:

  • Placeholder to put project name + description
  • How to install via
    • Cocoapods
    • Carthage
    • Swift Package Manager
    • Manually - it might be useful to link to a dedicated page that breaks down the steps
  • Placeholder to put code examples
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

1 participant