chore: Minor refactoring and rework of the readme
This commit is contained in:
parent
7d74a80520
commit
2275c5dbd1
16
README.md
16
README.md
@ -4,8 +4,18 @@ Just another note editor written in VUE.js for learning purposes.
|
|||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
|
||||||
This is version 1.0.0 - with the basic setup to creating, deleting and editing new notes.
|
To get a better understanding of the VUE.js framework, I wanted to create a tool for my personal usage.
|
||||||
There is no persistent storage a reload deletes all notes.
|
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
|
## Coming next
|
||||||
|
|
||||||
@ -17,7 +27,7 @@ There is no persistent storage a reload deletes all notes.
|
|||||||
* [ ] link rendering
|
* [ ] link rendering
|
||||||
* [ ] code rendering
|
* [ ] code rendering
|
||||||
* [ ] emoji 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)
|
* [ ] 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
|
* [ ] 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
|
* [ ] Website to inform the user about and give the user an entry point for JANE
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "jane",
|
"name": "jane",
|
||||||
"private": true,
|
"private": true,
|
||||||
"version": "1.0.0",
|
"version": "1.0.1",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"description": "Just another note editor written in VUE.js for learning purposes.",
|
"description": "Just another note editor written in VUE.js for learning purposes.",
|
||||||
"homepage": "https://projects.nisch.codes/nischcodes/JANE#readme",
|
"homepage": "https://projects.nisch.codes/nischcodes/JANE#readme",
|
||||||
|
@ -1,8 +1,5 @@
|
|||||||
<script setup lang="ts">
|
<script setup lang="ts">
|
||||||
import { ref } from 'vue'
|
|
||||||
|
|
||||||
const props = defineProps(['active_note', 'notes'])
|
const props = defineProps(['active_note', 'notes'])
|
||||||
|
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user