Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Doc updates#68 #70

Merged
merged 5 commits into from
Sep 7, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@ Bespoken Tools (bst) - Tools for Alexa Skills Kit Development


## Overview
The **bst** (aka Bespoken Tools aka the BEAST) makes it easy to develop for Alexa/Echo.
The **bst** (aka Bespoken Tools) makes it easy to develop for Alexa/Echo.

We call it working in BEAST mode - rampage through code/test iterations as Alexa requests are sent **directly** to your laptop.
Do not slow-down for:
* Time-consuming server deployments
* Over-complicated and error-prone packaging scripts
* Seemingly-innocuous-but-still-pesky service restarts.

The current version provides three commands - **proxy http**, **proxy lambda** and **speak**.

Expand All @@ -30,28 +36,28 @@ Using NPM:
$ npm install bespoken-tools -g
```

For additional help, see [Getting Started](http://docs.bespoken.tools/en/latest/getting_started.html)
For additional help, see [Getting Started](http://docs.bespoken.tools/en/latest/getting_started)

## bst proxy Command

The proxy command allows you to interact with a local service running on your machine via an Alexa device.

Read the docs [here](http://docs.bespoken.tools/en/latest/commands/proxy.html).
Read the docs [here](http://docs.bespoken.tools/en/latest/commands/proxy).

## bst speak Command

The speak command generates intent requests for your service as if they were coming from Alexa itself.
It works in a manner very similar to the Alexa simulator available via the Alexa developer console.

Read the docs [here](http://docs.bespoken.tools/en/latest/commands/speak.html).
Read the docs [here](http://docs.bespoken.tools/en/latest/commands/speak).

## Tutorials

* [Nodejs Lambda Tutorial](http://docs.bespoken.tools/en/latest/tutorials/tutorial_local_server_java.html)
* [Java Server Tutorial](http://docs.bespoken.tools/en/latest/tutorials/tutorial_lambda_nodejs.html)
* [Nodejs Lambda Tutorial](http://docs.bespoken.tools/en/latest/tutorials/tutorial_local_server_java)
* [Java Server Tutorial](http://docs.bespoken.tools/en/latest/tutorials/tutorial_lambda_nodejs)

## Questions/Feedback?

Email jpk@xappmedia.com with any questions or comments, also feel free to open an [issue](https://github.com/bespoken/bst/issues/new) for a bug or feature request.
Take to us on [Gitter](https://gitter.im/bespoken/bst), also feel free to open an [issue](https://github.com/bespoken/bst/issues/new) for a bug or feature request.

We love to hear feedback.
18 changes: 18 additions & 0 deletions docs/commands/proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,15 @@ $ bst proxy lambda index.js

You can learn more here at our [Node.js Tutorial](/tutorials/tutorial_lambda_nodejs):

**Options**

The `--verbose` flag will print out the requests and responses from all calls made to your skill.

To use it, just start up the proxy with:
```bash
$ bst proxy lambda index.js --verbose
```

## bst proxy http

**Overview**
Expand All @@ -54,6 +63,15 @@ $ bst proxy http 9999

You can learn more here at our [Java Tutorial](/tutorials/tutorial_local_server_java)

**Options**

The `--verbose` flag will print out the requests and responses from all calls made to your skill.

To use it, just start up the proxy with:
```bash
$ bst proxy http 9999 --verbose
```

## bst proxy urlgen

**Overview**
Expand Down
8 changes: 7 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@


## Overview
The **bst** (aka Bespoken Tools aka the BEAST) makes it easy to develop for Alexa/Echo.
The **bst** (aka Bespoken Tools) makes it easy to develop for Alexa/Echo.

We call it working in BEAST mode - rampage through code/test iterations as Alexa requests are sent **directly** to your laptop.
Do not slow-down for:
* Time-consuming server deployments
* Over-complicated and error-prone packaging scripts
* Seemingly-innocuous-but-still-pesky service restarts.

The current version provides three commands - **proxy http**, **proxy lambda** and **speak**.

Expand Down