diff --git a/examples/engagement/README.md b/examples/engagement/README.md new file mode 100644 --- /dev/null +++ b/examples/engagement/README.md @@ -0,0 +1,9 @@ +# Example: Engagement + +This configuration file includes a feed for watching for engagement with your websites. + +## Instructions + +1. Create the feed and replace `ATURI` with the full record AT-URI. Should look like `at://YOUR_DID/app.bsky.feed.generator/some_rkey` +2. Update the `DID` placeholders with your DID. There are several references, so be sure to update all of them. + diff --git a/examples/my_stuff/README.md b/examples/my_stuff/README.md new file mode 100644 --- /dev/null +++ b/examples/my_stuff/README.md @@ -0,0 +1,9 @@ +# Example: My Stuff + +This configuration file shows how you can make a personalized feed based of your posts, replies to your posts, and posts where you are quoted. + +## Instructions + +1. Create the feed and replace `ATURI` with the full record AT-URI. Should look like `at://YOUR_DID/app.bsky.feed.generator/some_rkey` +2. Update the `DID` placeholders with your DID. There are several references, so be sure to update all of them. + diff --git a/examples/private_my_stuff/README.md b/examples/private_my_stuff/README.md new file mode 100644 --- /dev/null +++ b/examples/private_my_stuff/README.md @@ -0,0 +1,12 @@ +# Example: Private My Stuff + +This configuration file shows how you can make a private personalized feed based of your posts, replies to your posts, and posts where you are quoted. + +This feed is configured with the `allow` attribute that has a list of DIDs that can access the feed. Any request coming from a DID not in that list sees the `deny` post. + +## Instructions + +1. Create the feed and replace `ATURI` with the full record AT-URI. Should look like `at://YOUR_DID/app.bsky.feed.generator/some_rkey` +2. Update the `DID` placeholders with your DID. There are several references, so be sure to update all of them. +3. Create a new post that people will see when the do not have access to the feed. Replace the `DENIED` placeholder with the full record AT-URI. Should look like `at://YOUR_DID/app.bsky.feed.post/some_rkey` + diff --git a/examples/tags/README.md b/examples/tags/README.md new file mode 100644 --- /dev/null +++ b/examples/tags/README.md @@ -0,0 +1,9 @@ +# Example: Tags + +This configuration file shows how you can make a personalized feed of posts with one or more tags. + +## Instructions + +1. Create the feed and replace `ATURI` with the full record AT-URI. Should look like `at://YOUR_DID/app.bsky.feed.generator/some_rkey` +2. Update the `DID` placeholders with your DID. There are several references, so be sure to update all of them. +