jody/notes.kaplon.us
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add LICENSE and README.

Browse Source
This commit is contained in:
Jody 2025-03-21 17:45:13 -04:00
parent 94f35fc857
commit 3a6f61de3e
2 changed files with 40 additions and 0 deletions

21
LICENSE Normal file
View File

@ -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.

19
README.md Normal file
View File

@ -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.