freshjots 0.4.0 → 1.0.1

package/README.md

@@ -1,49 +1,8 @@
-# freshjots — JS, TS, Windows CLI 
+# freshjots — JS, TS, Windows CLI
 
 Tiny JavaScript client for the [Fresh Jots](https://freshjots.com) API.
 One file, zero dependencies (uses Node 18's global `fetch`).
 
-## Install
-
-```sh
-npm install freshjots
-```
-
-(Or `pnpm add freshjots`, `yarn add freshjots`, `bun add freshjots`.)
-
-## Use
-
-```js
-import { Client } from "freshjots";
-
-// Reads FRESHJOTS_TOKEN from the environment by default.
-const client = new Client();
-
-// Append text to a note (creates it if missing).
-await client.append("cron-jobs-prod", "backup ok");
-
-// Read a note's body.
-const note = await client.note("cron-jobs-prod");
-console.log(note.plain_body);
-
-// List your notes (most recent activity first). Pass options to sort/filter:
-const notes = await client.notes({ sort: "created", folderId: 3, limit: 20 });
-for (const n of notes) console.log(`${n.id}\t${n.filename}\t${n.title}`);
-
-// Create a note. The API derives the filename from the title — for a
-// note addressable by an exact filename, use append() instead.
-const created = await client.create({ title: "Research 2026 Q2", body: "Initial outline." });
-console.log(created.filename); // server-derived stream name
-```
-
-Client methods: `notes({ sort, folderId, limit, offset })`,
-`note(filename)`, `noteById(id)`, `create({ title, body })`,
-`append(filename, text)`, `remove(id)`, `move(id, folderId)`, and
-`folders()`. `note()`/`noteById()`/`create()` return the note object
-directly (no `{ note: … }` wrapper); `notes()` and `folders()` return
-arrays. For `notes()`, `sort` is `created|updated|appended` and
-`folderId` may be a folder id or `"none"` (un-foldered only).
-
 ## CLI
 
 Installing the package globally puts a `freshjots` command on your
@@ -54,7 +13,10 @@ automatically.
 
 ```sh
 npm install -g freshjots
-export FRESHJOTS_TOKEN=mn_…           # PowerShell: $env:FRESHJOTS_TOKEN = "mn_…"
+
+# Persist the token for every new shell (macOS defaults to zsh; use ~/.bashrc on bash):
+echo 'export FRESHJOTS_TOKEN=mn_…' >> ~/.zshrc && source ~/.zshrc
+# Windows PowerShell: [Environment]::SetEnvironmentVariable("FRESHJOTS_TOKEN", "mn_…", "User")
 ```
 
 The CLI covers reading, writing, and organizing notes:
@@ -71,6 +33,7 @@ freshjots append cron-jobs-prod "ok"      # text may also be piped on stdin
 freshjots rm cron-jobs-prod               # delete by id or filename
 freshjots mv cron-jobs-prod Work          # move into a folder (id or name); --root to un-folder
 freshjots folders                         # prints "<id>\t<name>" per row
+freshjots --version                       # print version (--help for full usage)
 ```
 
 Both `create` and `append` read from stdin when the body or text isn't
@@ -92,6 +55,47 @@ Exit codes: `0` on success, `1` on runtime errors (missing token,
 network failure, non-2xx API response — printed as `Error: HTTP <status>
 <code>: <message>`), `2` on usage errors.
 
+## Install
+
+```sh
+npm install freshjots
+```
+
+(Or `pnpm add freshjots`, `yarn add freshjots`, `bun add freshjots`.)
+
+## Use
+
+```js
+import { Client } from "freshjots";
+
+// Reads FRESHJOTS_TOKEN from the environment by default.
+const client = new Client();
+
+// Append text to a note (creates it if missing).
+await client.append("cron-jobs-prod", "backup ok");
+
+// Read a note's body.
+const note = await client.note("cron-jobs-prod");
+console.log(note.plain_body);
+
+// List your notes (most recent activity first). Pass options to sort/filter:
+const notes = await client.notes({ sort: "created", folderId: 3, limit: 20 });
+for (const n of notes) console.log(`${n.id}\t${n.filename}\t${n.title}`);
+
+// Create a note. The API derives the filename from the title — for a
+// note addressable by an exact filename, use append() instead.
+const created = await client.create({ title: "Research 2026 Q2", body: "Initial outline." });
+console.log(created.filename); // server-derived stream name
+```
+
+Client methods: `notes({ sort, folderId, limit, offset })`,
+`note(filename)`, `noteById(id)`, `create({ title, body })`,
+`append(filename, text)`, `remove(id)`, `move(id, folderId)`, and
+`folders()`. `note()`/`noteById()`/`create()` return the note object
+directly (no `{ note: … }` wrapper); `notes()` and `folders()` return
+arrays. For `notes()`, `sort` is `created|updated|appended` and
+`folderId` may be a folder id or `"none"` (un-foldered only).
+
 ## TypeScript
 
 Types ship with the package — no `@types/freshjots` needed, no `.d.ts`

package/index.js

@@ -18,7 +18,7 @@
 // payload ({ "notes": [...] }). show / show-by-filename / create return
 // the note object at the TOP LEVEL — there is no { "note": ... } wrapper.
 
-export const VERSION = "0.4.0";
+export const VERSION = "1.0.1";
 const DEFAULT_BASE_URL = "https://freshjots.com/api/v1";
 
 export class ApiError extends Error {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "freshjots",
-  "version": "0.4.0",
+  "version": "1.0.1",
   "description": "Tiny JavaScript client for the Fresh Jots API. Append-only notebooks for cron jobs, deploy scripts, and bots.",
   "type": "module",
   "main": "index.js",