From 3a6f61de3ebd059de16cc83d9e84b9013ee14586 Mon Sep 17 00:00:00 2001 From: Jody Date: Fri, 21 Mar 2025 17:45:13 -0400 Subject: [PATCH] Add LICENSE and README. --- LICENSE | 21 +++++++++++++++++++++ README.md | 19 +++++++++++++++++++ 2 files changed, 40 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..eb6fdea --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Jody Kaplon + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..fc868a7 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# notes.kaplon.us # +Minimum viable notes app. +All notes go into a single, plaintext file. +All changes are backed up and synced to multiple clients thanks to websockets, node, and git. + +vim mode is ~~strictly enforced~~ highly encouraged (apologies for forcing my keybindings on you): +- `:` and `;` are swapped +- `jj` escapes insert mode / `ctrl + c` works as well + +Markdown is highlighted, but not rendered. + +A working demo is hosted at [notes.kaplon.us](https://notes.kaplon.us). +Login with credentials `demo/demo`. +Open a new incognito browser window, log in again, and watch your changes appear in the other window. +Complete version history is committed to a separate [data repo](https://hub.kaplon.us/jody/note-data-demo/commits/branch/master). + +This side-project uses the excellent [CodeMirror editor](http://codemirror.net). +The experience from a mobile-browser isn't great, but my main use case is within a desktop browser. +