Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hobofan/yaks-simple


https://github.com/hobofan/yaks-simple

Last synced: 22 days ago
JSON representation

Awesome Lists containing this project

README

        

# Yaks::Simple

This gem adds the `:simple_json` format to yaks.
`:simple_json` completely ignores the purpose of yaks to build a hypermedia API
and currently doesn't render any links, just resource attributes.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'yaks-simple'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install yaks-simple

## Usage

TODO: Write usage instructions here

## Contributing

1. Fork it ( https://github.com/[my-github-username]/yaks-simple/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request