summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorSeba Gamboa <[email protected]>2015-09-25 19:23:40 -0300
committerSeba Gamboa <[email protected]>2015-09-25 19:23:40 -0300
commitb69f8455a7659d3f24dbb8e47ac6745cad3b9bd7 (patch)
tree7db82e366db17db46a77ae43e29be1e62e74df9b /README.md
parent0f0a68159a3c5a3b0ed6e0867afbcdfa770ff342 (diff)
downloadyard-mruby-b69f8455a7659d3f24dbb8e47ac6745cad3b9bd7.tar.gz
yard-mruby-b69f8455a7659d3f24dbb8e47ac6745cad3b9bd7.zip
Update README description
Diffstat (limited to 'README.md')
-rw-r--r--README.md3
1 files changed, 1 insertions, 2 deletions
diff --git a/README.md b/README.md
index 8f77953..82dcff6 100644
--- a/README.md
+++ b/README.md
@@ -3,8 +3,7 @@
[![Gem](https://img.shields.io/gem/v/yard-mruby.svg)](https://rubygems.org/gems/yard-mruby)
[![Travis](https://img.shields.io/travis/sagmor/yard-mruby.svg)](https://travis-ci.org/sagmor/yard-mruby)
-This is a plugin that allows YARD to parse and generate documentation for MRuby sources.
-It handles the different C API
+This is a plugin that allows YARD to parse and generate documentation for MRuby sources as well as documenting it's C APIs.
## Usage