README.md in rdoc-markdown-0.1.2 vs README.md in rdoc-markdown-0.1.3
- old
+ new
@@ -1,11 +1,10 @@
+!!! This is just experimental gem
+
# Rdoc::Markdown
+This gem is focused on spitting readable markdown files based on rdoc documentation. It should also come with sqlite database as an index (but this is so far only in plans).
-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/rdoc/markdown`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add rdoc-markdown
@@ -13,21 +12,40 @@
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install rdoc-markdown
## Usage
+First thing to do, is to install a gem
-TODO: Write usage instructions here
+`gem install rdoc-markdown`
+Then proceed to directory where you want to generate documentation:
+
+`rdoc --format=markdown"
+
+Don't forget to append `--debug` to have a bit more information in case thing fail (and they will probably do, because this entire thing is experimental).
+
## Development
+Biggest issue is testing this locally, but that's not as hard to do these days.
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```
+gem build rdoc-markdown.gemspec
+```
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```
+gem install <path-to>/rdoc-markdown-0.1.2.gem
+```
+or you can do the same, but through gemfile:
+
+```
+gem 'rdoc-markdown`, path: "../rdoc-markdown/`
+```
+
## Release
```
gem build rdoc-markdown.gemspec
+gem push rdoc-markdown-0.1.2.gem
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rdoc-markdown. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rdoc-markdown/blob/master/CODE_OF_CONDUCT.md).