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

Update readme #406

Merged
merged 3 commits into from
Mar 30, 2018
Merged

Update readme #406

merged 3 commits into from
Mar 30, 2018

Conversation

alexdebrie
Copy link
Contributor

@alexdebrie alexdebrie commented Mar 30, 2018

What did you implement:

Updates the README and adds examples, specifically:

  • Removed API documentation from the README and into a section of the docs. Link.
  • Added plugin examples and updated the Quick Start to point to the examples.
  • Removed Plugin System from README and moved into separate docs page. We can re-add this to top-level once plugin system is more fully developed.

How did you implement it:

N/A

How can we verify it:

N/A

Todos:

  • Write tests
  • Write documentation
  • Fix linting errors
  • Make sure code coverage hasn't dropped
  • Provide verification commands / resources
  • Enable "Allow edits from maintainers" for this PR
  • Update the messages below

Is this ready for review?: YES
Is it a breaking change?: NO

@codecov
Copy link

codecov bot commented Mar 30, 2018

Codecov Report

Merging #406 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #406   +/-   ##
=======================================
  Coverage   65.13%   65.13%           
=======================================
  Files          26       26           
  Lines        1592     1592           
=======================================
  Hits         1037     1037           
  Misses        512      512           
  Partials       43       43

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ff09341...dd93c3a. Read the comment docs.

@ganeshvlrk ganeshvlrk self-requested a review March 30, 2018 18:15
Copy link
Contributor

@ganeshvlrk ganeshvlrk left a comment

Choose a reason for hiding this comment

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

Looks good.

@alexdebrie alexdebrie merged commit 3ffe17c into master Mar 30, 2018
@alexdebrie alexdebrie deleted the UpdateReadme branch March 30, 2018 19:19
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

Successfully merging this pull request may close these issues.

None yet

2 participants