Skip to content
This repository was archived by the owner on Aug 10, 2024. It is now read-only.

Commit 62f9d9f

Browse files
committed
README cleanup & shuffle
1 parent f9350ac commit 62f9d9f

File tree

1 file changed

+26
-30
lines changed

1 file changed

+26
-30
lines changed

README.md

+26-30
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,41 @@
22
# Contrails
33

44
Contrails is an [ATProto Feed Generator](https://github.com/bluesky-social/feed-generator) backed by
5-
[Cloudflare Workers](https://workers.cloudflare.com) and Bluesky Search.
5+
[Cloudflare Workers](https://workers.cloudflare.com) and [Bluesky Search](https://bsky.app/search).
66

7-
Edit `CONFIG.md` to define your feed generator.
7+
Fork or copy the repository and edit `CONFIG.md` to define your feed generator.
88

9-
Deploy right from [GitHub Actions](https://github.com/features/actions).
9+
Deploy right from [GitHub Actions](https://github.com/features/actions) to [Cloudflare Workers](https://workers.cloudflare.com).
1010

1111
The current release is [**0.0.3**](https://github.com/jcsalterego/Contrails/releases/latest).
1212

13-
## A Post
14-
15-
![](docs/thecloud.png)
16-
17-
_[Holds hand to earpiece]_ I'm being told Bluesky Search is now called [Palomar](https://github.com/bluesky-social/indigo/tree/main/cmd/palomar). RIP thecloud, we hardly knew ye.
18-
1913
## Requirements
2014

2115
- Bluesky Social account
2216
- GitHub account ([Sign up](https://github.com/signup) or [Login](https://github.com/login))
2317
- Cloudflare account ([Sign up](https://dash.cloudflare.com/sign-up) or [Login](https://dash.cloudflare.com/login/))
2418
- A moderate-to-high tolerance for adventure
2519

20+
## Installation & Configuration: The Short Version
21+
22+
1. Create a Cloudflare Worker
23+
2. Create a Cloudflare API Token (the Edit Workers template is fine)
24+
3. Create a Bluesky App Password
25+
4. Fork this repository
26+
5. In your fork's **Settings > Secrets and variables > Actions**, set the following:
27+
* Variable: `BLUESKY_HANDLE`
28+
* Variable: `CLOUDFLARE_ACCOUNT_ID`
29+
* Variable: `CLOUDFLARE_WORKER_NAME`
30+
* Secret: `BLUESKY_APP_PASSWORD`
31+
* Secret: `CLOUDFLARE_API_TOKEN`
32+
6. Edit [CONFIG.md](CONFIG.md) in your fork
33+
7. Go to **Actions** > **1. Check Requirements**, select **Run Workflow**, refresh and wait for completion
34+
8. Go to **Actions** > **2. Deploy to Cloudflare**, select **Run Workflow**, refresh and wait for completion
35+
9. Go to **Actions** > **3. Publish Feed Generator**, select **Run Workflow**, refresh and wait for completion
36+
10. Visit the `BLUESKY_HANDLE` profile, e.g. [https://bsky.app/profile/jcsalterego.bsky.social](https://bsky.app/profile/jcsalterego.bsky.social) and then the Feeds tab
37+
38+
The longer (and incomplete) instructions can be found in [INSTALL.md](INSTALL.md).
39+
2640
## Upgrading
2741

2842
In the event you'd like to pull in the latest changes into a fork of Contrails, GitHub has great documentation here:
@@ -45,29 +59,11 @@ In the event you'd like to pull in the latest changes into a fork of Contrails,
4559

4660
* Initial Release
4761

48-
## Installation & Configuration: The Short Version
62+
## Etymology
4963

50-
1. Create a Cloudflare Worker
51-
2. Create a Cloudflare API Token (the Edit Workers template is fine)
52-
3. Create a Bluesky App Password
53-
4. Fork this repository
54-
5. In your fork's **Settings > Secrets and variables > Actions**, set the following:
55-
* Variable: `BLUESKY_HANDLE`
56-
* Variable: `CLOUDFLARE_ACCOUNT_ID`
57-
* Variable: `CLOUDFLARE_WORKER_NAME`
58-
* Secret: `BLUESKY_APP_PASSWORD`
59-
* Secret: `CLOUDFLARE_API_TOKEN`
60-
6. Edit [CONFIG.md](CONFIG.md) in your fork
61-
7. Go to **Actions** > **1. Check Requirements**, select **Run Workflow**, refresh and wait for completion
62-
8. Go to **Actions** > **2. Deploy to Cloudflare**, select **Run Workflow**, refresh and wait for completion
63-
9. Go to **Actions** > **3. Publish Feed Generator**, select **Run Workflow**, refresh and wait for completion
64-
10. Visit the `BLUESKY_HANDLE` profile, e.g. [https://bsky.app/profile/jcsalterego.bsky.social](https://bsky.app/profile/jcsalterego.bsky.social) and then the Feeds tab
65-
66-
## Installation & Configuration: Director's Cut
67-
68-
Here is the currently incomplete, long unabridged version of Installation and Configuration:
64+
![](docs/thecloud.png)
6965

70-
[INSTALL.md](INSTALL.md) `under-construction.gif`
66+
_Ed. Note: Bluesky Search is now called [Palomar](https://github.com/bluesky-social/indigo/tree/main/cmd/palomar)._
7167

7268
## Publishing Diagram
7369

0 commit comments

Comments
 (0)