aboutsummaryrefslogtreecommitdiffstats
path: root/examples/networkauth/redditclient/doc/redditclient.rst
diff options
context:
space:
mode:
Diffstat (limited to 'examples/networkauth/redditclient/doc/redditclient.rst')
-rw-r--r--examples/networkauth/redditclient/doc/redditclient.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/examples/networkauth/redditclient/doc/redditclient.rst b/examples/networkauth/redditclient/doc/redditclient.rst
new file mode 100644
index 000000000..48b720abb
--- /dev/null
+++ b/examples/networkauth/redditclient/doc/redditclient.rst
@@ -0,0 +1,21 @@
+Reddit Example
+==============
+
+Demonstrates authenticating with OAuth 2 to access Reddit.
+
+The Reddit example uses OAuth 2, as supported by Qt Network Authorization,
+to sign in to Reddit and display the Reddit posts (in text format) associated
+with the authenticated user.
+
+To use this example, a consumer key from Reddit is needed.
+To register the application visit https://www.reddit.com/prefs/apps/.
+
+.. note::
+ Choose installed app when creating the application.
+
+.. note::
+ Set the redirect URI to http://127.0.0.1:1337/ in Reddit settings.
+
+.. image:: redditclient.png
+ :width: 400
+ :alt: Reddit Example Screenshot