@adrianmg/noted 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Adrian Mato <yensamg@github.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,106 @@
-# Temporary Holding Version
+<p align="center">
+	<h1 align="center">
+		<img src="https://raw.githubusercontent.com/adrianmg/noted/main/docs/logo.png" alt="noted's logo: a floppy disk" width="128">
+		<br>
+		noted
+	</h1>
+	<p align="center">Markdown notes in your terminal, as if they ran on MS-DOS.<br>Opens instantly, saves as you type, keeps every note as a plain Markdown file.</p>
+	<p align="center">
+		<a href="https://www.npmjs.com/package/@adrianmg/noted"><img src="https://img.shields.io/npm/v/%40adrianmg%2Fnoted?label=npm&color=0000aa" alt="npm version" height="18"></a>
+		<a href="https://github.com/adrianmg/noted/releases"><img src="https://img.shields.io/github/v/release/adrianmg/noted?label=release&color=00aaaa" alt="Latest release" height="18"></a>
+		<a href="https://noted.computer"><img src="https://img.shields.io/badge/website-noted.computer-ffff55" alt="Website: noted.computer" height="18"></a>
+	</p>
+</p>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<p align="center">
+	<br>
+	<img src="https://raw.githubusercontent.com/adrianmg/noted/main/docs/demo.gif" alt="noted starting from the shell: a new note with a task list, ticking a task, the notes list, finding a note as you type, then the Amber theme" width="720">
+	<br>
+</p>
+
+## Installation
+
+```sh
+# npm: macOS, Linux and Windows (Node 18 or newer)
+npm install -g @adrianmg/noted
+
+# Homebrew: macOS and Linux
+brew tap adrianmg/noted https://github.com/adrianmg/noted
+brew trust adrianmg/noted
+brew install noted
+
+# Install script: checks the build against the release's checksums
+curl -fsSL https://noted.computer/install | sh      # macOS, Linux
+irm https://noted.computer/install.ps1 | iex        # Windows, in PowerShell
+```
+
+## Usage
+
+```sh
+noted                     # a new note, cursor ready
+noted buy oat milk        # a new note that starts with those words
+noted --theme amber       # turbo, amber, phosphor, charcoal, lime, midnight,
+                          # catppuccin, dracula, gruvbox, rosepine, synthwave
+noted --dir ~/Notes       # keep notes in another folder this time
+noted --path              # print where your notes are
+noted --help              # every option
+```
+
+## What it does
+
+noted opens on a new note in about 2.5 ms and saves as you type, so there's
+no save button and nothing to lose. Each note is a plain Markdown file named
+after its first line, in a `Noted` folder in iCloud Drive when it's on, or
+else in Documents, where any editor can open it: `noted --path` prints where,
+and Noted ▸ Notes folder… moves them elsewhere. Markdown is lit as you type,
+finding searches every note as you type, and it all looks like MS-DOS:
+pull-down menus, Norton Commander panes and eleven themes. It runs on macOS,
+Linux and Windows, in any terminal.
+
+## Keys
+
+| Key | |
+|---|---|
+| `ESC` | Notes list, and back |
+| `⌘F` or `^F` | Find a note, or create one |
+| `^N` | New note |
+| `^T` | Make a task, tick it |
+| `^G` | Insert a table |
+| `^D` | Delete the note (to the Trash; `^Z` puts it back) |
+| `F10` | Menus |
+| `F1` | Every key |
+| `^Q` | Exit |
+
+On a PC, read `⌘` as `^` and `⌥` as `ALT`.
+
+## Updating
+
+```sh
+npm install -g @adrianmg/noted     # npm
+brew upgrade noted                 # Homebrew
+```
+
+With the install scripts, run them again.
+
+## Why?
+
+A thought is gone in seconds, and most notes apps take longer than that to
+open. noted is a terminal away, ready before you finish pressing Enter, and
+leaves you nothing but plain files in a folder you own.
+
+Do you want to know more? [Visit noted.computer](https://noted.computer),
+with a live demo and the User's Guide.
+
+## Questions? Ideas? Bugs?
+
+[Open an issue](https://github.com/adrianmg/noted/issues) or hit me
+up on [Twitter](https://twitter.com/adrianmg).
+
+This repository holds noted's releases, its Homebrew formula and this README;
+the npm package, [@adrianmg/noted](https://www.npmjs.com/package/@adrianmg/noted),
+ships the same builds.
+
+## License
+
+Made by [Adrián Mato](https://adrianmato.com). Available under the terms of
+the [MIT License](https://github.com/adrianmg/noted/blob/main/LICENSE).

package/bin/noted

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+'use strict';
+// `noted` as npm first links it: a stand-in that starts this system's build with the same arguments, terminal
+// and exit status. On macOS and Linux, install.js then puts the build itself here, so nothing stands between
+// the shell and noted as it starts. This runs on Windows, and where install scripts are turned off.
+
+const fs = require('fs');
+const { spawnSync } = require('child_process');
+
+let exe;
+try {
+  exe = require('../builds.js').build();
+} catch (e) {
+  console.error('noted: ' + e.message);
+  process.exit(1);
+}
+if (process.platform !== 'win32') {
+  // A package manager may unpack the build without its execute bit.
+  try { fs.accessSync(exe, fs.constants.X_OK); } catch (e) { try { fs.chmodSync(exe, 0o755); } catch (e2) { /* reported below */ } }
+}
+const run = spawnSync(exe, process.argv.slice(2), { stdio: 'inherit' });
+if (run.error) {
+  console.error('noted: ' + run.error.message);
+  process.exit(1);
+}
+if (run.signal) process.kill(process.pid, run.signal);
+process.exit(run.status === null ? 1 : run.status);

package/builds.js

@@ -0,0 +1,19 @@
+'use strict';
+// Which of the package's builds runs on this system. pack.mjs puts them in vendor/, from the release's files.
+
+const path = require('path');
+
+const BUILDS = {
+  'darwin arm64': 'darwin/noted', // one binary for Apple silicon and Intel
+  'darwin x64': 'darwin/noted',
+  'linux x64': 'linux-x64/noted', // static: any distribution
+  'linux arm64': 'linux-arm64/noted',
+  'win32 x64': 'win32-x64/noted.exe',
+  'win32 arm64': 'win32-x64/noted.exe', // Windows on Arm runs it emulated
+};
+
+exports.build = function build() {
+  const file = BUILDS[process.platform + ' ' + process.arch];
+  if (!file) throw new Error('no build for ' + process.platform + ' on ' + process.arch + ' yet: https://noted.computer');
+  return path.join(__dirname, 'vendor', file);
+};

package/install.js

@@ -0,0 +1,37 @@
+'use strict';
+// After npm links `noted` to bin/noted (a Node stand-in), on macOS and Linux this puts this system's build in
+// its place: the link then starts noted itself, in a couple of milliseconds, with no Node in between.
+//
+// Only under npm, which links bin/noted as it is. Other package managers may write a shim that runs it with
+// node, which a native file would break; on Windows, npm's .cmd shim does. There the stand-in stays, and it
+// works. Anything going wrong here leaves the stand-in too: an install never fails for this.
+
+const fs = require('fs');
+const path = require('path');
+
+function main() {
+  if (process.platform === 'win32') return;
+  if (!/^npm\//.test(process.env.npm_config_user_agent || '')) return;
+  let build;
+  try {
+    build = require('./builds.js').build();
+    fs.accessSync(build);
+  } catch (e) {
+    return;
+  }
+  const bin = path.join(__dirname, 'bin', 'noted');
+  const tmp = bin + '.' + process.pid;
+  try {
+    // A hard link takes no more room; where there can't be one, a copy.
+    try { fs.linkSync(build, tmp); } catch (e) { fs.copyFileSync(build, tmp); }
+    fs.chmodSync(tmp, 0o755);
+    // Atomic: bin/noted is always one or the other. Run again, it may already be this very file, and
+    // rename() leaves both names: the spare one goes.
+    fs.renameSync(tmp, bin);
+  } catch (e) {
+    // The stand-in stays.
+  }
+  try { fs.unlinkSync(tmp); } catch (e) { /* gone, as it should be */ }
+}
+
+main();

package/package.json

@@ -1,6 +1,54 @@
 {
   "name": "@adrianmg/noted",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "Markdown notes in your terminal, as if they ran on MS-DOS: opens instantly, saves as you type, and keeps each note as a plain .md file.",
+  "keywords": [
+    "notes",
+    "markdown",
+    "terminal",
+    "tui",
+    "cli",
+    "ms-dos",
+    "icloud"
+  ],
+  "homepage": "https://noted.computer",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/adrianmg/noted.git"
+  },
+  "bugs": {
+    "url": "https://github.com/adrianmg/noted/issues"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Adrián Mato",
+    "url": "https://adrianmato.com"
+  },
+  "bin": {
+    "noted": "bin/noted"
+  },
+  "scripts": {
+    "postinstall": "node install.js"
+  },
+  "files": [
+    "bin/",
+    "vendor/",
+    "builds.js",
+    "install.js"
+  ],
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}