From 589f336a7209dfa197282a686a07d64579085cb1 Mon Sep 17 00:00:00 2001
From: Dessalines <dessalines@users.noreply.github.com>
Date: Sat, 4 May 2024 14:42:51 -0400
Subject: [PATCH] Better readme example. (#261)

* Better readme example.

* Update README.md

Co-authored-by: SleeplessOne1917 <28871516+SleeplessOne1917@users.noreply.github.com>

---------

Co-authored-by: SleeplessOne1917 <28871516+SleeplessOne1917@users.noreply.github.com>
---
 README.md | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index c195a04..910ec31 100644
--- a/README.md
+++ b/README.md
@@ -22,15 +22,28 @@ A javascript / typescript http client and type system for [Lemmy](https://github
 [LemmyHttp docs](https://join-lemmy.org/api/classes/LemmyHttp.html)
 
 ```ts
-import { LemmyHttp, Login } from 'lemmy-js-client';
+import { LemmyHttp, Login } from "lemmy-js-client";
 
-let baseUrl = 'https://lemmy.ml';
-let client: LemmyHttp = new LemmyHttp(baseUrl, headers?);
-let loginForm: Login = {
+// Build the client
+const baseUrl = "https://lemmy.ml";
+const client: LemmyHttp = new LemmyHttp(baseUrl);
+
+// Build the login form
+const loginForm: Login = {
   username_or_email: "my_name",
   password: "my_pass",
 };
-let jwt = await client.login(loginForm).jwt;
+
+// Login and set the client headers with your jwt
+const { jwt } = await client.login(loginForm);
+client.setHeaders({ Authorization: `Bearer ${jwt}` });
+
+// Fetch top posts for the day
+const getPostsForm: GetPosts = {
+  sort: "TopDay",
+  type_: "Local",
+};
+const posts = await client.getPosts(getPostsForm);
 ```
 
 ## Development