Skip to content

Commit

Permalink
DOC CoGo Skill
Browse files Browse the repository at this point in the history
Add documentation for the Columbus Bikeshare skill and add logos for the skill.
  • Loading branch information
Stephen Hoover committed Dec 23, 2016
1 parent 4086e74 commit 977c782
Show file tree
Hide file tree
Showing 6 changed files with 53 additions and 29 deletions.
7 changes: 6 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,9 @@
.idea
*config.py
requests*
#*
#*

# I need to install external libraries in the code
# directory for packaging in the Lambda function
boto3*
s3transfer*
38 changes: 22 additions & 16 deletions PRIVACY_POLICY.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,34 @@
This privacy policy describes how the Chicago Bikeshare Alexa
skill ("the skill") collects and uses personal information.
This privacy policy describes how the Chicago Bike Share Status Alexa
skill and the Columbus Bike Share Status Alexa skill ("the skill")
collects and uses personal information.

# What we store

The only personal information stored by the skill is user-provided
addresses. You may use the skill without providing an address,
in which case we store no information about you. If you choose
to store an address, it will be connected with a unique, randomly-generated ID.
The skill recognizes you only through this unique ID.
in which case the skill stores no information about you. If you choose
to store an address, it will be connected with a unique ID,
randomly-generated by Amazon. The skill recognizes you only through
this unique ID.

# When we store it

If you choose to provide an address (for example, by saying
"Echo, tell Chicago Bikeshare to add my origin address.", or
"Echo, tell Chicago Bikeshare to add my destination address."),
"Echo, tell Columbus Bikeshare to add my destination address."),
you will be guided through a dialog
to input address information. At the conclusion of the dialog,
you will be asked to confirm the address. If you do not confirm
the address, no information will be stored.
the address, no information will be stored. If you do confirm
the address, that address will be stored for later use.

# How we use personal information

Addresses provided to the skill will be used only to inform users
about the status of Divvy stations near that address.
Your personal information will not be made available to any third party
for any purpose.
Addresses provided to the skill will be used only to
determine which Divvy or CoGo stations are nearest to your
location(s) of interest so that the skill can inform you
about the status of those stations. Your personal information
will not be made available to any third party for any purpose.

# How we store personal information

Expand All @@ -34,9 +38,11 @@ resources provided by Amazon Web Services.
# How you can control your information

You may ask what, if any, address the skill has stored for you
by asking "Echo, tell me what origin address is stored" or
"Echo, tell me what destination address is stored".
by asking "Echo, ask Chicago bikeshare to tell me what origin
address is stored" or "Echo, ask Columbus bikeshare to tell
me what destination address is stored".
At any time, you may request that we remove your information by
saying "Echo, delete my addresses". If you request that the
skill delete your address information and confirm the request,
the skill will retain no record of your personal information.
saying "Echo, tell Chicago bikeshare to delete my addresses".
If you request that the skill delete your address information
and confirm the request, the skill will retain no record of your
personal information.
35 changes: 24 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,33 @@
![Chicago Bikeshare Logo](/assets/108px_logo.png)
# Chicago Bikeshare
![Chicago Bike share Logo](/assets/108px_logo.png) ![Columbus Bike share Logo](/assets/108px_columbus_logo.png)
# Chicago Bike Share Status and Columbus Bike Share Status

A skill for Amazon Alexa<br>
https://www.amazon.com/Mark-of-Progress-Chicago-Status/dp/B01LZROIFI/<br>

## Overview

This skill lets you check the status of stations in the Chicago
Divvy bike sharing network. You can request the number of bikes,
The Chicago Bike Share Status skill lets you check the status
of stations in the Chicago Divvy bike sharing network, and
the Columbus Bike Share Status skill does the same for the
CoGo network in Columbus. Each skill has the same features and
commands; the Chicago Bike Share Status skill will recognize
street and station names in Chicago, IL, while the Columbus
Bike Share Status skill will recognize street and station names
in Columbus, OH.

You can request the number of bikes,
docks, or both from any specific station. Use the station name,
such as "Orleans Street and Elm Street" or "Adler Planetarium"
to make the request. Station names are displayed at the stations
themselves and on the Divvy website. The names are generally either
themselves and on the Divvy or CoGo website. The names are generally either
the nearest cross-street or a nearby significant landmark. If you
only remember one street name, you can say "Alexa, ask Chicago
bikeshare what stations are on Grand" (or whatever the street is)
for a list of all stations on that street.
for a list of all stations on that street. (Or "Alexa, ask
Columbus bikeshare what stations are on Rich Street", for example.)

To easily check the status of stations you use every day, the
Chicago Bikeshare skill will let Alexa remember an origin and
skills will let Alexa remember an origin and
destination address. If you choose to store an address, Alexa
will be able to give you the number of bikes available at the
station closest to your origin and the number of docks at the
Expand All @@ -40,11 +50,14 @@ You can always check what address(es) you have stored with, e.g.,
by saying "remove my addresses".

This skill is not sponsored by, endorsed by, or affiliated with
Divvy Bikes. For more information about Divvy, visit their website at
http://www.divvybikes.com/.
either Divvy Bikes or CoGo Bike Share.
For more information about Divvy, visit their website at
http://www.divvybikes.com/. The official CoGo website is
https://www.cogobikeshare.com/.

## Things you can say
### Things you can say

(Replace "Chicago" with "Columbus" for the CoGo network.)
- Alexa, ask Chicago Bikeshare how many bikes are at the Ashland Avenue and Grand Avenue station.
- Alexa, ask Chicago Bikeshare to check my commute.
- Alexa, ask Chicago Bikeshare to store an address.
Expand All @@ -69,7 +82,7 @@ This file should define the following attributes at global level:
- default_city : The name of the city in which the network operates, e.g. "Chicago"
- time_zone : The local time zone, e.g. "US/Central" or "US/Eastern"
- sample_station : A valid station name for use in the help prompt
- divvy_api : Web address of the bike sharing network's API. As of September 2016, the Divvy network's API is https://feeds.divvybikes.com/stations/stations.json.
- bikes_api : Web address of the bike sharing network's API. As of September 2016, the Divvy network's API is https://feeds.divvybikes.com/stations/stations.json, and the CoGo network's API is http://feeds.cogobikeshare.com/stations/stations.json .
- maps_api : Web address of the Google Maps Geocoding API (used when users store addresses). As of September 2016, this is https://maps.googleapis.com/maps/api/geocode/.
- maps_api_key : Token which allows access to the Google Maps Geocoding API
- aws_region : Region in which you have your database
Expand Down
Binary file added assets/108px_columbus_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/512px_columbus_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion assets/COPYRIGHT.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
The Chicago Bikeshare logo is &copy; 2016 to Lydia CL Hoover (http://lydiahooverphotography.com/), all rights reserved, and is used here and in the Alexa Skill store by permission.
The Chicago Bikeshare logo and Columbus Bikeshare logo are &copy; 2016 to Lydia CL Hoover (http://lydiahooverphotography.com/), all rights reserved, and is used here and in the Alexa Skill store by permission.

0 comments on commit 977c782

Please sign in to comment.