NyanHelsing / starfall

10 stars 2 forks source link

Add tl;dr section to README targeted at developers - 'how it works' #5

Open TreyE opened 5 months ago

TreyE commented 5 months ago

This project is impressive, and after watching the videos, I understand why the decisions to implement it the way it is implemented were made:

  1. Tiktok doesn't really offer a reporting API (the API in general is lackluster)
  2. Certain things you can only really do using the app, without the hassle of setting up your own app (you also can't just access the API with creds, you have to configure a developer application (yuck))
  3. Playwright offers the easiest way to do browser interaction that jives with the source data format (js/json)

Because developers are basically short attention span theatre (myself included) - it might be helpful to add a short summary of the videos in the readme rather than having to watch them - with developers written as the target audience. I think this might aid contribution by allowing, for example, new contributors to understand how the rubber hits the road and why the fastest. I know when I'm looking at a repo being able to grok it within about 5 minutes helps. I'll also include some more things such as project layout.

I'll send a PR that way you can 👍 or 👎 it yourself if you don't think this is useful.