README.rdoc in bjond-api-0.0.4 vs README.rdoc in bjond-api-0.1.0
- old
+ new
@@ -2,10 +2,16 @@
A rubygem wrapper for the Bjönd API.
This gem also contains an engine with endpoints that are made to interface with Bjond server-core.
+== Installation
+
+ gem install 'bjond-api'
+
+For specific version info visit the gem page[https://rubygems.org/gems/bjond-api].
+
== Creating a Bjond Integration App
To create a Bjond App using the Ruby on Rails framework, perform the following actions within your Rails application.
(1) Add the following line to your Gemfile -
@@ -25,12 +31,10 @@
(4) At this point, you can run the migrations as usual using -
rake db:migrate
-The `config.paths['db/migrate']` line can be removed once the migrations are copied.
-
(5) Generate Configuration Files
To get you started, generate a config file by running the following command:
rails g initializer
@@ -67,7 +71,16 @@
== API Methods
- register_app
+
+- fire_event
+
+
+
+== Environment Variables
+
+- BJOND_ADAPTER_AUDIENCE
+- BJOND_ADAPTER_SUBJECT