https://github.com/jsmestad/sinatra-documentation

https://github.com/jsmestad/sinatra-documentation

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/jsmestad/sinatra-documentation
• Owner: jsmestad
• License: mit
• Created: 2012-02-23T03:26:03.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-03-02T00:03:48.000Z (over 12 years ago)
• Last Synced: 2024-03-15T02:51:11.034Z (8 months ago)
• Language: Ruby
• Homepage: https://github.com/jsmestad/sinatra-documentation
• Size: 99.6 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sinatra-documentation

An extension for a Sinatra application that allows your routes to automatically return

help documentation by specifying a route with a '.readme' extension

(ie. '/users/show.readme') and rendering the matched '.md' file.

**NOTE** This is still under development. It works, but will make API changes as it gets

more flushed out.

## Installation

Add this line to your application's Gemfile:

    gem 'sinatra-documentation'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install sinatra-documentation

## Usage

TODO: Write usage instructions here

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Added some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request