Sha256: c3c3fab0eb4e6f370467183438132d73131ed1053272bf484bfcefe9166a1f65

Contents?: true

Size: 1.52 KB

Versions: 3

Compression:

Stored size: 1.52 KB

Contents

# Ush

ush (**U**rl **SH**ortener) is a small service that will shorten urls in a snap.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'ush'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install ush

## Usage

Install the gem and run `ush`. After that, your service should be running at `localhost:80`

## 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/cbrnrd/ush. 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 Ush project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cbrnrd/ush/blob/master/CODE_OF_CONDUCT.md).

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
ush-0.1.1 README.md
ush-0.1.0b README.md
ush-0.1.0 README.md