Skip to content

Commit 6e6ae5c

Browse files
committed
Update readme to indicate new state of the project
1 parent 80006c7 commit 6e6ae5c

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1+
# No longer maintained
2+
*Great news for Plex and Amazon Echo fans alike!!* I am going to be working directly with Plex to make an official Alexa Plex skill, which will be totally streets ahead.
13

2-
[![Travis](https://img.shields.io/travis/OverloadUT/alexa-plex.svg?style=flat-square)](https://travis-ci.org/OverloadUT/alexa-plex)
3-
[![Coveralls](https://img.shields.io/coveralls/OverloadUT/alexa-plex.svg?style=flat-square)](https://coveralls.io/r/OverloadUT/alexa-plex)
4-
[![Join the chat at https://gitter.im/OverloadUT/alexa-plex](https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat-square)](https://gitter.im/OverloadUT/alexa-plex?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
4+
Stay tuned to Plex's [official channels](https://blog.plex.tv/) for more!
5+
6+
The final state of this public project will remain here for people to learn from, but no further development should be expected.
7+
8+
*(original readme follows)*
59

610
# alexa-plex
711
Alexa (Amazon Echo) app for interacting with a Plex Server and controlling client playback
@@ -17,16 +21,14 @@ Here's an early proof-of-concept video
1721

1822
# Install for Development
1923

20-
I accept Pull Requests! To get set up for development simply:
21-
2224
1. ```npm install``` to install all dependencies
2325
2. ```npm test``` to verify that all tests are passing. If they are, you're ready to rock!
2426

2527
## AWS Lambda
2628
The app is meant to be deployed as an **AWS Lambda** function. Setting that up is beyond the scope of this readme though. There's a deploy.bat file in this project that will deploy to AWS Lambda if you're on Windows, but you will need to have the AWS toolkit installed and configured, and have an "alexa-plex" function set up.
2729

2830
## Dynamo DB
29-
This app requires DynamoDB. You'll need to get that set up and create a table named `AlexaPlexUsers`
31+
This app requires DynamoDB. You'll need to get that set up and create a table named `AlexaPlexUsers` with a primary string key of `userid`
3032

3133
## Testing on a live Plex server
3234
You need to define a few environment variables to tell this app how to talk to your Plex server. The project is set up to use ```dotenv``` so you can simply create a ```.env``` file in the project root to define all of the needed variables. Here's a template:

0 commit comments

Comments
 (0)