diff --git a/docs/guide/features.md b/docs/guide/features.md index 12ab531..1863668 100644 --- a/docs/guide/features.md +++ b/docs/guide/features.md @@ -37,40 +37,33 @@ Trotsky provides comprehensive support for the Bluesky AT Protocol. Below is a l **StepStarterPacks** | :white_check_mark: | Get a list of starter packs by their URIs. | ```Trotsky.init(agent).starterPacks([uri1, uri2]).each()``` **StepStreamPosts** | :test_tube: | Stream posts from the firehose. | ```Trotsky.init(agent).streamPosts().each()``` **StepTimeline** | :white_check_mark: | Get the authenticated user's timeline. | ```Trotsky.init(agent).timeline().take(20).each()``` + **StepSearchActors** | :white_check_mark: | Search for actors by name/handle. | ```Trotsky.init(agent).searchActors({ q: "typescript" }).each()``` + **StepPostLikers** | :white_check_mark: | Get actors who liked a post. | ```Trotsky.init(agent).post("at://...").likers().each()``` + **StepPostReposters** | :white_check_mark: | Get actors who reposted a post. | ```Trotsky.init(agent).post("at://...").reposters().each()``` + **StepPostQuotes** | :white_check_mark: | Get quote posts of a post. | ```Trotsky.init(agent).post("at://...").quotes().each()``` + **StepPostThread** | :white_check_mark: | Get a full post thread with replies. | ```Trotsky.init(agent).post("at://...").thread()``` + **StepPostUnlike** | :white_check_mark: | Unlike a post. | ```Trotsky.init(agent).post("at://...").unlike()``` + **StepPostUnrepost** | :white_check_mark: | Unrepost a post. | ```Trotsky.init(agent).post("at://...").unrepost()``` + **StepDeletePost** | :white_check_mark: | Delete a post. | ```Trotsky.init(agent).post("at://...").delete()``` + **StepActorBlocks** | :white_check_mark: | Get all actors blocked by the user. | ```Trotsky.init(agent).blocks().each()``` + **StepActorMutes** | :white_check_mark: | Get all actors muted by the user. | ```Trotsky.init(agent).mutes().each()``` + **StepActorKnownFollowers** | :white_check_mark: | Get known followers (mutual connections). | ```Trotsky.init(agent).actor('bsky.app').knownFollowers().each()``` + **StepActorSuggestions** | :white_check_mark: | Get suggested actors to follow. | ```Trotsky.init(agent).suggestions().each()``` + **StepFeed** | :white_check_mark: | Get posts from a custom feed. | ```Trotsky.init(agent).feed("at://...").each()``` + **StepFeedGenerator** | :white_check_mark: | Get a custom feed generator. | ```Trotsky.init(agent).feedGenerator("at://...")``` + **StepSuggestedFeeds** | :white_check_mark: | Get suggested custom feeds. | ```Trotsky.init(agent).suggestedFeeds().take(10)``` + **StepListFeed** | :white_check_mark: | Get posts from a list feed. | ```Trotsky.init(agent).list("at://...").feed().each()``` + **StepListBlock** | :white_check_mark: | Block a list. | ```Trotsky.init(agent).list("at://...").block()``` + **StepListUnblock** | :white_check_mark: | Unblock a list. | ```Trotsky.init(agent).list("at://...").unblock()``` + **StepListMute** | :white_check_mark: | Mute a list. | ```Trotsky.init(agent).list("at://...").mute()``` + **StepListUnmute** | :white_check_mark: | Unmute a list. | ```Trotsky.init(agent).list("at://...").unmute()``` + **StepNotifications** | :white_check_mark: | Get user notifications. | ```Trotsky.init(agent).notifications().take(20)``` + **StepNotificationsUnreadCount** | :white_check_mark: | Get unread notification count. | ```Trotsky.init(agent).notificationsUnreadCount()``` + **StepNotificationsUpdateSeen** | :white_check_mark: | Mark notifications as seen. | ```Trotsky.init(agent).notificationsUpdateSeen()``` + **StepThreadMute** | :white_check_mark: | Mute a thread. | ```Trotsky.init(agent).post("at://...").threadMute()``` + **StepThreadUnmute** | :white_check_mark: | Unmute a thread. | ```Trotsky.init(agent).post("at://...").threadUnmute()``` -## Planned Features - -The following features are planned for future implementation: - - **Name** | **Status** | **Description** | **Potential API** ----|---|---|--- - **StepActorBlocks** | :construction: | Get all actors blocked by the user. | `app.bsky.graph.getBlocks` - **StepActorKnownFollowers** | :construction: | Get known followers (mutual connections). | `app.bsky.graph.getKnownFollowers` - **StepActorMutes** | :construction: | Get all actors muted by the user. | `app.bsky.graph.getMutes` - **StepActorSuggestions** | :construction: | Get suggested actors to follow. | `app.bsky.actor.getSuggestions` - **StepDeletePost** | :construction: | Delete a post. | Delete post record - **StepFeed** | :construction: | Get posts from a custom feed. | `app.bsky.feed.getFeed` - **StepFeedGenerator** | :construction: | Get a custom feed generator. | `app.bsky.feed.getFeedGenerator` - **StepListBlock** | :construction: | Block a list. | `app.bsky.graph.listblock` - **StepListFeed** | :construction: | Get posts from a list feed. | `app.bsky.feed.getListFeed` - **StepListMute** | :construction: | Mute a list. | `app.bsky.graph.muteActorList` - **StepListUnblock** | :construction: | Unblock a list. | Delete listblock record - **StepListUnmute** | :construction: | Unmute a list. | `app.bsky.graph.unmuteActorList` - **StepNotifications** | :construction: | Get user notifications. | `app.bsky.notification.listNotifications` - **StepNotificationsUnreadCount** | :construction: | Get unread notification count. | `app.bsky.notification.getUnreadCount` - **StepNotificationsUpdateSeen** | :construction: | Mark notifications as seen. | `app.bsky.notification.updateSeen` - **StepPostLikers** | :construction: | Get actors who liked a post. | `app.bsky.feed.getLikes` - **StepPostQuotes** | :construction: | Get quote posts of a post. | `app.bsky.feed.getQuotes` - **StepPostReposters** | :construction: | Get actors who reposted a post. | `app.bsky.feed.getRepostedBy` - **StepPostThread** | :construction: | Get a full post thread with replies. | `app.bsky.feed.getPostThread` - **StepPostUnlike** | :construction: | Unlike a post. | Delete like record - **StepPostUnrepost** | :construction: | Unrepost a post. | Delete repost record - **StepSearchActors** | :construction: | Search for actors by name/handle. | `app.bsky.actor.searchActors` - **StepSuggestedFeeds** | :construction: | Get suggested custom feeds. | `app.bsky.feed.getSuggestedFeeds` - **StepThreadMute** | :construction: | Mute a thread. | `app.bsky.graph.muteThread` - **StepThreadUnmute** | :construction: | Unmute a thread. | `app.bsky.graph.unmuteThread` - - :white_check_mark: Implemented • :test_tube: Experimental • :x: In PR/Review • :construction: Planned + :white_check_mark: Implemented • :test_tube: Experimental