@plannotator/tot 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +16 -0
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -8,6 +8,11 @@
8
8
 
9
9
  Publish a markdown or HTML file to a live link in one command. No signup.
10
10
 
11
+ The useful part is that it is **git-backed publishing**, not a one-off upload. The link you share is
12
+ living, like a branch: run `tot update` and the same URL moves forward. Every publish also creates a
13
+ real version with a frozen `@hash` URL, like a commit, so you can point people at either "latest" or
14
+ "exactly this snapshot."
15
+
11
16
  ```bash
12
17
  npm i -g @plannotator/tot
13
18
  ```
@@ -30,6 +35,17 @@ tot notes.md
30
35
  | `tot remove <link>` | Remove the living page from its share link. |
31
36
  | `tot login --key <key>` | Optional. Publish as an owned account instead of anonymous. |
32
37
 
38
+ ## Why it exists
39
+
40
+ Most "put this online" tools either render your markdown, hide the source behind an app, or give you
41
+ a new URL every time you change something. `tot` is deliberately smaller:
42
+
43
+ - Markdown and HTML are served raw, byte for byte.
44
+ - The share link stays stable across updates.
45
+ - Each update is still preserved as an immutable version.
46
+ - HTML support files next to the page are uploaded first, so real HTML pages keep working.
47
+ - No account is needed for the default flow; the link is the key.
48
+
33
49
  ## How it works
34
50
 
35
51
  Files are served byte for byte. Markdown comes back as raw markdown. HTML comes back as raw HTML.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@plannotator/tot",
3
- "version": "0.1.0",
4
- "description": "Publish a markdown or HTML file to a living tot.page URL. A tiny CLI over the Workspaces /v1 API.",
3
+ "version": "0.1.1",
4
+ "description": "Git-backed publishing for Markdown and HTML: one living tot.page URL with immutable @hash snapshots.",
5
5
  "keywords": [
6
6
  "cli",
7
7
  "markdown",