From 84442115d89f630d0390bf3d609f00ca12af8e08 Mon Sep 17 00:00:00 2001 From: Eric Date: Mon, 8 Jun 2020 16:49:47 -0500 Subject: [PATCH] Create README.md for Bess --- gems/bess/README.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/gems/bess/README.md b/gems/bess/README.md index 95afd4bc..a666f136 100644 --- a/gems/bess/README.md +++ b/gems/bess/README.md @@ -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.