Skip to content

mattschmitz/SADb

Repository files navigation

Sadb

SADb (Schmitz-Arbus Database) is a simple relational database for ruby projects.

Installation

Add this line to your application's Gemfile:

gem 'sadb'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install sadb

Usage

TODO: Write usage instructions here

Development

Run bin/setup to install dependencies. 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 tags, and push the .gem file to rubygems.org.

This repo uses rufo and rubocop for formatting and style enforcement. To install rufo globally, run gem install rufo. You can then run rufo . to format all files in the directory. There are various plugins for text editors - for vs-code we recommend vscode-rufo

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sadb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

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

Code of Conduct

Everyone interacting in the Sadb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

A simple relational database for Ruby projects

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published