Skip to content
This repository was archived by the owner on Oct 3, 2023. It is now read-only.

Update README and generated code docs#71

Merged
chingor13 merged 11 commits intomasterfrom
readme
Nov 20, 2017
Merged

Update README and generated code docs#71
chingor13 merged 11 commits intomasterfrom
readme

Conversation

@chingor13
Copy link
Copy Markdown
Member

  • Simplified the primary README to show the basics.
  • Each class should now have at least one example for how to use it.
  • Methods tagged 'internal' will not appear in the generated documentation.
  • Fixed 'see' links to be anchor links in the generated documentation.

@chingor13 chingor13 requested a review from tmatsuo November 20, 2017 18:37
Comment thread README.md
This library follows [Semantic Versioning][semver].

Please note it is currently under active development. Any release versioned
0.x.y is subject to backwards incompatible changes at any time.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: It is not clear from this doc that which state this library is. I assume it's alpha, but there's no mention

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a badge image that shows the latest released packagist version and added a Status: Pre-Alpha below the descriptions of the general status.

@chingor13 chingor13 merged commit 32468e5 into master Nov 20, 2017
@chingor13 chingor13 deleted the readme branch November 20, 2017 20:11
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants