From 2275c5dbd1193f4442ca8f15d2b4f1e7dd001e6f Mon Sep 17 00:00:00 2001 From: "nisch.codes" Date: Sun, 16 Mar 2025 08:55:25 +0100 Subject: [PATCH] chore: Minor refactoring and rework of the readme --- README.md | 16 +++++++++++++--- package.json | 2 +- src/components/Sidebar.vue | 3 --- 3 files changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 49f615f..7344930 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,18 @@ Just another note editor written in VUE.js for learning purposes. ## Description -This is version 1.0.0 - with the basic setup to creating, deleting and editing new notes. -There is no persistent storage a reload deletes all notes. +To get a better understanding of the VUE.js framework, I wanted to create a tool for my personal usage. +I am a big fan of the apple notes app, sadly there is no linux port, therefore I started this project not to create such port, +but to have a portfolio application to learn more about typescript and VUE.js and to have an excuse why I have to use Vite for a project. + +## License + +This Project is based on a YouTube Video by Tylor Potts (https://www.youtube.com/watch?v=YwUvSa9Ckqo) and therfore I am releasing this code under the GPL 3 license. + +## Versions + +- Version 1.0.1 - basic CRUD for notes, persitancy with browser based localstorage. Minor refactoring and rework of the readme +- Version 1.0.0 - with the basic setup to creating, deleting and editing new notes. There is no persistent storage a reload deletes all notes. ## Coming next @@ -17,7 +27,7 @@ There is no persistent storage a reload deletes all notes. * [ ] link rendering * [ ] code rendering * [ ] emoji rendering -* [ ] persistent storage based on something like local storage of the browser +* [x] persistent storage based on something like local storage of the browser * [ ] persistent storage based on backend api (can be edited by the user) * [ ] PWA Setup so that the "app" can be installed on the users system * [ ] Website to inform the user about and give the user an entry point for JANE diff --git a/package.json b/package.json index abdecea..36453d9 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "jane", "private": true, - "version": "1.0.0", + "version": "1.0.1", "type": "module", "description": "Just another note editor written in VUE.js for learning purposes.", "homepage": "https://projects.nisch.codes/nischcodes/JANE#readme", diff --git a/src/components/Sidebar.vue b/src/components/Sidebar.vue index 16d6a3c..7ac933b 100644 --- a/src/components/Sidebar.vue +++ b/src/components/Sidebar.vue @@ -1,8 +1,5 @@