NPO-Accounting/houdini
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Create README.md for Bess

Browse source
This commit is contained in:
Eric 2020-06-08 16:49:47 -05:00 committed by Eric Schultz
parent 595b39d3ed
commit 84442115d8
1 changed files with 11 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
gems/bess/README.md
View file

@ -1,25 +1,24 @@
# Bess
Short description and motivation.
In order to simplify and make Houdini extensible, we move some of Houdini's setup and
configuration into a separate Gem. We call this support library Bess, in honor of
Harry Houdini's wife and long-time assistant, Bess Houdini.
## Usage
How to use my plugin.
Everything you can get via `Bess` is accessible via `Houdini` in the main houdini app.
As an example, let's say Bess has a string constant named `Bess::PRESTO`. From
your Houdini app, you can use `Houdini::PRESTO` to access this constant.
We recommend using this pattern.
## Installation
Add this line to your application's Gemfile:
This really should only be used in Houdini itself for now.
```ruby
gem 'bess'
gem 'bess', path: 'gems/bess'
```
And then execute:
```bash
$ bundle
```
Or install it yourself as:
```bash
$ gem install bess
```
## Contributing
Contribution directions go here.