readme (#31)

README.md

@@ -1,6 +1,38 @@
 # Citi Bike Dock Data
 
-A website to allow users to look up usage for their favorite Citi Bike docks
+A website to allow users to look up usage for their favorite Citi Bike docks.
+Also has views by borough, community district, and council district.
+
+# Frequently Asked Questions
+
+## Where does the data come from?
+
+Citi Bike publishes monthly data to an s3 bucket here. I pull down this data, format it to fit in a database, and then store it there. A program checks for new data each morning.
+Why isn't the most recent month available?
+
+Sometimes Citi Bike is slow in uploading new data, so it might be that. Otherwise, if you see the data available at the link above but it's been more than a day and it's still not here, there might have been a bug in my code. Hopefully I'll see it soon. Feel free to open an issue on GitHub or email me about it at [email protected].
+
+## Where can I find the code?
+
+Here.
+
+## What are you counting?
+
+I'm counting each docking and undocking as an individual use. That means most trips generate two uses, and usually at two different docks. I consider this the most valuable number because it shows how many times a dock is providing value to someone in a day/month. If you are looking for data about trips taken, you will have to find that elsewhere, sorry.
+
+## How far back does the data go?
+
+Citi Bike publishes data as far back as June 2013. All of that data is available here.
+
+## I found a bug or I have a feature request or suggestion
+
+Feel free to open an issue on GitHub or email me about it at [email protected].
+
+## I think I found a missing dock, or something else looks weird
+
+I'll be blunt: Citi Bike's data is pretty messy. Sometimes they move docks and/or change names, which makes the data look kind of weird, but there's not really anything I can do about that. I also sometimes have to drop trips (a tiny fraction of a percent of trips) because the row is malformed. If you think you've found something really wrong, or you're just not sure, feel free to open an issue on GitHub or send me an email at [email protected].
+
+Oh, and I don't include docks in New Jersey or Canada.
 
 # Local Setup
 
@@ -30,3 +62,11 @@ A website to allow users to look up usage for their favorite Citi Bike docks
   - `npx prisma studio`
 - Further Prisma CLI commands can be found on [their
   website](https://www.prisma.io/docs/orm/tools/prisma-cli)
+
+# Special Thanks
+A huge thanks to the following people who helped make this possible:
+
+- [Aileen Zhou](https://ayleinee.com/)
+- [Carly Jones](https://github.com/carly-jones)
+- [Catt Small](https://cattsmall.com/)
+- All the fine folks at [Transportation Alternatives](https://transalt.org/)