Sha256: daa73c5153662a75b223cca2647909c3f41f0cd0999a9e76d2eeed4912fbfa59

Contents?: true

Size: 1.5 KB

Versions: 3

Compression:

Stored size: 1.5 KB

Contents

# Howareya

Welcome! This is the Howareya gem, its designed to connect to a howareya instance and post data to it

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'howareya'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install howareya

## Usage

Create an initialiser file with the following block:

```
Howareya.configure do |config|
  config.url = url
  config.api_key = api_key
end
```

Replacing url with the url of your instance and api_key with the key created for your app inside the instance

## 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]/howareya. 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).

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
howareya-0.1.3 README.md
howareya-0.1.2 README.md
howareya-0.1.1 README.md