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

Consistent README #8

Closed
mattheworiordan opened this issue Apr 20, 2015 · 1 comment
Closed

Consistent README #8

mattheworiordan opened this issue Apr 20, 2015 · 1 comment
Labels
enhancement New feature or improved functionality.

Comments

@mattheworiordan
Copy link
Member

See https://github.com/ably/ably-ruby/blob/master/README.md for an example of a common format used for the client library README. The README must include examples of using the most common features.

We must also include:

  • Installation instructions including how to install from a package manager i.e. similar to NPM or RubyGems
  • License info
  • Build status
@mattheworiordan mattheworiordan added the enhancement New feature or improved functionality. label Apr 20, 2015
@bladeSk
Copy link
Contributor

bladeSk commented Apr 29, 2015

Done

@kouno kouno closed this as completed May 18, 2015
@charles85 charles85 mentioned this issue Jan 4, 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
enhancement New feature or improved functionality.
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mattheworiordan @kouno @bladeSk