A very simple Ruby SSG as a library.
Find a file
2024-09-08 21:21:37 -04:00
.github/workflows initial commit 2024-09-08 20:58:18 -04:00
bin initial commit 2024-09-08 20:58:18 -04:00
lib Fix misc. errors 2024-09-08 21:17:46 -04:00
sig initial commit 2024-09-08 20:58:18 -04:00
test initial commit 2024-09-08 20:58:18 -04:00
.gitignore initial commit 2024-09-08 20:58:18 -04:00
.standard.yml initial commit 2024-09-08 20:58:18 -04:00
Gemfile initial commit 2024-09-08 20:58:18 -04:00
Gemfile.lock initial commit 2024-09-08 20:58:18 -04:00
LICENSE.txt initial commit 2024-09-08 20:58:18 -04:00
phlexite.gemspec update gemspec 2024-09-08 21:21:37 -04:00
Rakefile initial commit 2024-09-08 20:58:18 -04:00
README.md initial commit 2024-09-08 20:58:18 -04:00
Steepfile initial commit 2024-09-08 20:58:18 -04:00

Phlexite

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

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

Installation

TODO: Replace UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_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.

Install the gem and add to the application's Gemfile by executing:

bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG

If bundler is not being used to manage dependencies, install the gem by executing:

gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/phlexite.

License

The gem is available as open source under the terms of the MIT License.