timkaechele/planet_express_express
1
0
Fork 0
Code

Add decent readme

Browse Source
This commit is contained in:
Tim Kächele 2023-09-07 12:47:46 +02:00
parent f000142bda
commit 5a208803b3
1 changed files with 11 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,33 +1,21 @@
# PlanetExpressExpress
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/planet_express_express`. To experiment with that code, run `bin/console` for an interactive prompt.
A data driven approach for solving a shipping discount calculator.
TODO: Delete this and the text above, and describe your gem
## Setup
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add planet_express_express
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install planet_express_express
- Ruby 3.x
## Usage
TODO: Write usage instructions here
Generating sample data
## Development
```sh
$ ruby bin/generate_data.rb $SAMPLE_SIZE > sample_file.txt
```
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.
Run the calculator
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 the created tag, 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]/planet_express_express. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/planet_express_express/blob/master/CODE_OF_CONDUCT.md).
## Code of Conduct
Everyone interacting in the PlanetExpressExpress project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/planet_express_express/blob/master/CODE_OF_CONDUCT.md).
```sh
$ ruby bin/run.rb sample_file.txt
```