Skip to content

Commit 7e98ae5

Browse files
committed
Add note about how to start the console to run the README example.
1 parent 4f0998c commit 7e98ae5

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@
44

55
## Features
66

7-
* Generated by [aws-codegen](https://github.com/jkakar/aws-codegen) using the same JSON descriptions of AWS services used to build
8-
the [AWS SDK for Go](https://github.com/aws/aws-sdk-go/tree/master/models/apis).
9-
* Supports AWS services that use `json` and `rest-json` protocols.
7+
* Generated by [aws-codegen](https://github.com/jkakar/aws-codegen) using the
8+
same JSON descriptions of AWS services used to build the
9+
[AWS SDK for Go](https://github.com/aws/aws-sdk-go/tree/master/models/apis).
10+
* Support for most AWS services that use `json` and `rest-json` protocols.
1011

1112
## Example
1213

13-
Listing Amazon Kinesis streams
14+
Listing Amazon Kinesis streams. Start a console with `iex -S mix`:
1415

1516
```elixir
1617
iex> client = %AWS.Client{access_key_id: "<access-key-id>",
@@ -36,10 +37,10 @@ iex> IO.inspect result
3637

3738
* Run `mix deps.get` to install.
3839

39-
4040
## Development
4141

42-
Code is generated using the [aws-codegen](https://github.com/jkakar/aws-codegen) library, from the JSON descriptions of AWS services provided by Amazon.
42+
Code is generated using the [aws-codegen](https://github.com/jkakar/aws-codegen)
43+
library from the JSON descriptions of AWS services provided by Amazon.
4344

4445
## Documentation
4546

@@ -63,4 +64,5 @@ mix test
6364

6465
## License
6566

66-
&copy; 2015-2017 Jamshed Kakar <[email protected]>. See `LICENSE` file for details.
67+
&copy; 2015-2017 Jamshed Kakar <[email protected]>. See `LICENSE` file for
68+
details.

0 commit comments

Comments
 (0)