Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
12 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,22 @@ | ||
| # Testingrecord | ||
| # testingrecord | ||
|
|
||
| TODO: Delete this and the text below, and describe your gem | ||
| - [History](#history) | ||
| - [Enabling gem methods](#enabling-gem-methods) | ||
| - [Usage](#usage) | ||
|
|
||
| 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/testingrecord`. To experiment with that code, run `bin/console` for an interactive prompt. | ||
| ## History | ||
|
|
||
| ## Installation | ||
| This in a new gem I've made to facilitate testing on websites where you want to track all data being created | ||
|
|
||
| TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org. | ||
| This gem was made to try solve the problem where I had been caching models each time at new jobs, | ||
| hopefully some of the stuff here will be useful | ||
|
|
||
| Install the gem and add to the application's Gemfile by executing: | ||
| The gem is currently version unstable | ||
|
|
||
| $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG | ||
| ## Enabling gem methods | ||
|
|
||
| If bundler is not being used to manage dependencies, install the gem by executing: | ||
|
|
||
| $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG | ||
| The gem methods TODO..... | ||
|
|
||
| ## 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 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]/testingrecord. | ||
| TODO... |