mirror of
https://github.com/captbaritone/webamp
synced 2024-11-23 08:39:15 +00:00
Add readmes
This commit is contained in:
parent
681ac7e4f4
commit
c5603619ef
10
packages/archive-org-webamp-integration-tests/README.md
Normal file
10
packages/archive-org-webamp-integration-tests/README.md
Normal file
@ -0,0 +1,10 @@
|
||||
# Archive.org Webamp Integration Test
|
||||
|
||||
This package contains an automated test to ensure that the [Webamp](https://webamp.org) integration on https://archive.org is still working correectly. It's run twice a day via a GitHub Action, which can be found [here](../../ia-integration-tests.yml).
|
||||
|
||||
## Run
|
||||
|
||||
```sh
|
||||
yarn
|
||||
node index.js
|
||||
```
|
19
packages/skin-database/README.md
Normal file
19
packages/skin-database/README.md
Normal file
@ -0,0 +1,19 @@
|
||||
# Winamp Skin Database
|
||||
|
||||
This package contains code for managing the collection of Winamp skins which are used for various projects related to [Webamp](https://webamp.org):
|
||||
|
||||
- [@winampSkins](https://twitter.com/winampskins) Twitter Bot
|
||||
- The Discord bot used in the Webamp Discord
|
||||
|
||||
## Discord Bot
|
||||
|
||||
The discord bot allows us to:
|
||||
|
||||
- Review skins for use by the Twitter bot
|
||||
- Upload new skins to the database
|
||||
- Get a screenshot of a given skin
|
||||
- Get a link/screenshot of a skin based on its hash
|
||||
|
||||
## Server
|
||||
|
||||
This package also includes a GraphQL interface for exploring skins. It is not currently used by anything, but can be useful for inspecting the data.
|
@ -1,5 +1,7 @@
|
||||
# Skin Archive Tools
|
||||
|
||||
**Note:** My goal is to merge this into the `skin-database` package.
|
||||
|
||||
A collection of scripts for managing the Internet Archive's collection of Winamp Skins.
|
||||
|
||||
It works as a data pipeline. The phases are:
|
||||
|
5
packages/tweetBot/README.md
Normal file
5
packages/tweetBot/README.md
Normal file
@ -0,0 +1,5 @@
|
||||
# Tweet Bot
|
||||
|
||||
This "package" is actually a Python script. Originally the [@winampskins](https://twitter.com/winampskins) Twitter bot was a Python script that ran as a cron job. I've since rewritten most of it in JavaScript. The core part that actually talks to the Twitter API is still written in Python. That last remaining code can be found here.
|
||||
|
||||
Hopefully it will soon be rewritten in JavaScript.
|
Loading…
Reference in New Issue
Block a user