docs

Author: chiubaca

.env.example

@@ -0,0 +1,8 @@
+SHIBE_LOL_CLIENT_SECRET=
+
+TWITTER_API_KEY=
+TWITTER_API_KEY_SECRET=
+TWITTER_ACCESS_TOKEN=
+TWITTER_ACCESS_TOKEN_SECRET=
+
+MASTODON_ACCESS_TOKEN_KEY=

DEVELOPMENT.md

@@ -0,0 +1,9 @@
+# Developing Locally
+
+1. Rename `.env.example` to `.env`. You will need API keys:
+
+- From a X(Twitter) developer account, https://developer.twitter.com.
+
+- From your access token key from your Mastodon instance. This is found in `Preferences > Development`. You will need to create a new application if you dont have one already
+
+2. You can then run the npm script starting with `dev:` to test posting whilst in local development

README.md

@@ -1,64 +1,17 @@
-[![Post Shiba To Twitter/X Hourly](https://github.com/chiubaca/shiba-every-hour/actions/workflows/post-shibe-twitter.yml/badge.svg)](https://github.com/chiubaca/shiba-every-hour/actions/workflows/post-shibe-twitter.yml)
-
 <div align="center">
 
 <h1> Shiba Every Hour </h1>
 
-  <p> A GitHub Action which posts a picture of a Shiba to Twitter every hour.</p> 
+  <p>posting shibas around the the inter-webs hourly</p> 
 
   <img src="https://user-images.githubusercontent.com/18376481/90677906-ed53a180-e255-11ea-9df6-a2f6a59f0154.png">
 
   <p>wow</p>
 
 </div>
 
-# Ok, seriously why?
-
-I like Shiba's ok?
-
-# But Seriously...
-
-
-There probably is a legit use case somewhere here... You just need to look harder.
-- Perhaps you want to tweet your application service status every hour via a health check API?
-- You could post a tweet every time is a PR is merged into your master branch?
-- You could post cat images every hour instead!?
-
-The sky's the limit!
-
-# Developing Locally
-
-1. Clone this repo to your machine.
-
-2. Create a `.env` in the root directory.
-
-3. Inside the `.env` you will need to create four variables. `CONSUMER_KEY` , `CONSUMER_SECRET`, `ACCESS_TOKEN_KEY` and `ACCESS_TOKEN_SECRET`. These need to be populated with your own Twitter API keys which you can get by signing up at https://developer.twitter.com/ .
-
-4. Your `.env` file should look something like this.
-```
-CONSUMER_KEY = hvdVM7ZGshibasaresogreat3ZvE5tXh0E4h
-CONSUMER_SECRET = 4ez9dEyAeGtbnXeca-ha-ha-M0i5wI02e1vPa
-ACCESS_TOKEN_KEY = 8185583706135142-not-a-real-key-gPwxau3Yi0adA
-ACCESS_TOKEN_SECRET = wow-fsaa2muchwoof
-```
-5. You can then run `npm run dev-shibe` to run the script locally.
-
-# Modifying the Action or Script
-
-Feel free to adapt this script for your own purposes.
-
-The hourly schedule is configured in `./.github/workflows/post-shibe.yml`.
-
-All the logic to fetch a Shiba image and post to Twitter is in `./index.js`.
-
-
-# Publishing to Github
-
-> ⚠ Do NOT publish your `.env` to GitHub. Doing this will let anyone send posts to your Twitter account on your behalf.
-
-1. Add your Twitter API as [GitHub secrets](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) like so:
-
-![Screenshot of GitHub Secrets with `CONSUMER_KEY`,`CONSUMER_SECRET`, `ACCESS_TOKEN_KEY` and `ACCESS_TOKEN_SECRET`](https://user-images.githubusercontent.com/18376481/90680314-95b73500-e259-11ea-8b06-75067520cefc.PNG)
-
-
-Happy hacking 🤓.  
+|    site    |      status    |
+|------------|----------------|
+| X(Twitter) | [![Post Shiba To Twitter/X Hourly](https://github.com/chiubaca/shiba-every-hour/actions/workflows/post-shibe-twitter.yml/badge.svg)](https://github.com/chiubaca/shiba-every-hour/actions/workflows/post-shibe-twitter.yml) |
+| Mastodon   | [![Post Shiba To Mastodon Hourly](https://github.com/chiubaca/shiba-every-hour/actions/workflows/post-shibe-mastodon.yml/badge.svg)](https://github.com/chiubaca/shiba-every-hour/actions/workflows/post-shibe-mastodon.yml) |
+| Bluesky    | coming soon... |