README.md in yard-mruby-0.1.0 vs README.md in yard-mruby-0.2.0
- old
+ new
@@ -1,39 +1,29 @@
-# Yard::Mruby
+# yard-mruby
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yard/mruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+[](https://rubygems.org/gems/yard-mruby)
+[](https://travis-ci.org/sagmor/yard-mruby)
-TODO: Delete this and the text above, and describe your gem
+This is a plugin that allows YARD to parse and generate documentation for MRuby sources as well as documenting it's C APIs.
-## Installation
+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/)
-Add this line to your application's Gemfile:
+## Usage
-```ruby
-gem 'yard-mruby'
-```
+Install with rubygems
-And then execute:
-
- $ bundle
-
-Or install it yourself as:
-
$ gem install yard-mruby
-## Usage
+And execute `mrbdoc` to generate the docs
-TODO: Write usage instructions here
-
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To install this gem onto your local machine, run `bundle exec rake install`.
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yard-mruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/sagmor/yard-mruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).