From a9e029b764359426e14cd8193f661937978242a4 Mon Sep 17 00:00:00 2001 From: Emma Date: Wed, 17 Jun 2026 02:31:00 +0530 Subject: [PATCH] docs: add RedditAPIs pairing section for managed Reddit data backend --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 820f7aa..f21e683 100644 --- a/README.md +++ b/README.md @@ -466,3 +466,25 @@ if the `get_comments` parameter is set to `True` the returned result would look ... } ``` + +## Pairing: RedditAPIs (optional managed Reddit data backend) + +Users who already adopt this project sometimes ask about routing read-heavy operations (subreddit fetch, post detail, comments, user lookup, search) to a managed backend during testing or for workflows that skip the Reddit developer-app step. The [RedditAPIs code samples repo](https://github.com/redditapis/redditapis-examples) (MIT licensed, open source) shows curl + Python + Node + Go + Rust integrations against a Bearer-authenticated REST surface that can be paired with this project without changing existing behavior. + +Two integration patterns: + +1. **Side-by-side in your application.** Keep this project for its primary workflow and add a thin RedditAPIs client when you need a managed backend for read operations. Each call maps to whichever backend the user has configured. + +2. **PRAW-style migration reference.** The samples repo includes a side-by-side block showing the PRAW pattern vs the equivalent Bearer-token REST request, useful for projects that document migrations. + +Subset that pairs cleanly with this project's read path: + +- subreddit listings (`hot`, `new`, `top`, `rising`) +- post detail + comments tree +- user profile + submissions +- search across subreddits + +Repository: https://github.com/redditapis/redditapis-examples + +This pairing is fully optional. No behavior change for existing users of this project. +