Contents

# BlogApi

Ruby wrapper for the API of my personal [blog](https://github.com/K-Sato1995/blog_backend).

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'blog_api'
```

And then execute:

```
$ bundle
```

Or install it yourself as:

```
$ gem install blog_api
```

## Usage

The examples are listed below.

```ruby
# Get all the categories.
BlogApi::Category.all
# Get all the tags.
BlogApi::Tag.all
# Get all the posts.
BlogApi::Post.all
# Get a specific post.
BlogApi::Post.post(post_id)
# Get all the featured posts.
BlogApi::Post.featured
```

## 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 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]/blog_api. 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](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the BlogApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/blog_api/blob/master/CODE_OF_CONDUCT.md).

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
blog_api-1.0.0	README.md