README.md in ralyxa-1.0.0 vs README.md in ralyxa-1.1.0
- old
+ new
@@ -1,9 +1,11 @@
# Ralyxa
A Ruby framework for interacting with Amazon Alexa. Designed to work with Sinatra, although can be used with a few other web frameworks.
+An example application implementing the gem can be played with [here](https://github.com/sjmog/ralyxa_example).
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -24,14 +26,14 @@
First, you've gotta pass the request from Sinatra to Ralyxa. Add a single `POST` route to your Sinatra application, with the following:
```ruby
require 'sinatra'
-require './lib/alexa'
+require 'ralyxa'
post '/' do
- Alexa::Skill.handle(request)
+ Ralyxa::Skill.handle(request)
end
```
Second, you've gotta define your intents. To define a new intent, create a directory called 'intents'. Inside there, create a `.rb` file:
@@ -137,24 +139,23 @@
standard_card = card("Hello World", "I'm alive!", "http://placehold.it/200")
ask("What do you think of the Standard card I just sent?", card: standard_card)
end
```
-##### TODO
-
-- Account linking :construction:
-- Audio directives :construction:
-- Reprompts :construction:
-- Generator?
-
## Development
After checking out the repo, run `bundle install` to install dependencies. Then, run `rspec` to run the tests. You can also run `irb` for an interactive prompt that will allow you to experiment.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/sjmog/ralyxa. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+The main areas of focus are:
+
+- Account linking :construction:
+- Audio directives :construction:
+- Reprompts :construction:
+- Generators?
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).