Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mockdeep/afk


https://github.com/mockdeep/afk

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

▢ ‣ ⁖ ⁛ ⁝ ⇰ ⋱ ▶ ► ▸ ◆ ☰ ⚉ ⚫ ✱ ➔ ➜ ➣ ➤ ➽ ➥

# Afk

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/afk`. To experiment with that code, run `bin/console` for an
interactive prompt.

TODO: Delete this and the text above, and describe your gem

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'afk'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install afk

## Usage

TODO: Write usage instructions here

## 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).

Trello board for test fixtures: https://trello.com/b/ui1o0UsE/afk-test-fixtures

## Contributing

Bug reports and pull requests are welcome on GitHub at
https://github.com/[USERNAME]/afk. 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).