summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorSeba Gamboa <[email protected]>2015-09-30 14:03:30 -0300
committerSeba Gamboa <[email protected]>2015-09-30 14:03:30 -0300
commit96b3d7696395a9b4b55ca1108b291bacd738f4f6 (patch)
treee79c2eb94c666d2ae0f2b86896b7587a24634e9c
parenta2ce558f0243077d152c6a703e737a68f9a3f301 (diff)
downloadyard-mruby-96b3d7696395a9b4b55ca1108b291bacd738f4f6.tar.gz
yard-mruby-96b3d7696395a9b4b55ca1108b291bacd738f4f6.zip
Link to generated MRuby core docs as sample.
[ci skip]
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index 82dcff6..1bbb07c 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,8 @@
This is a plugin that allows YARD to parse and generate documentation for MRuby sources as well as documenting it's C APIs.
+It still has it's [rough edges and missing features](https://github.com/sagmor/yard-mruby/issues) but you can see a [sample from it's current state when executed on MRuby's core here](https://sagmor.com/mruby/)
+
## Usage
Install with rubygems