Skip to content

Commit d714dcd

Browse files
committed
chore(readme): Update README file to include extra information and credits
1 parent db9d137 commit d714dcd

1 file changed

Lines changed: 25 additions & 2 deletions

File tree

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# RedNotes Plus
22

3-
An SVG note taking application
3+
An SVG-based note taking application
44

55
## What is RedNotes Plus?
66

77
RedNotes Plus is my take on a modern, simple and intuitive note taking
88
application for stylus input. It was primarily developed for my use in classes,
99
but is of course available for any use case imaginable. By default, it uses [Catppuccin
10-
Mocha](https://github.com/catppuccin/catppuccin) as its color palette, but custom themes are planned soon as well.
10+
Mocha](https://github.com/catppuccin/catppuccin) as its color palette. However, custom
11+
themes are planned soon as well.
1112

1213
## What was your motivation?
1314

@@ -25,6 +26,10 @@ a simple, intuitive yet powerful note-taking software.
2526
- ✏️ Pressure-sensitive stylus input
2627
- 📂 Custom file format
2728

29+
## Installation
30+
31+
If you want to try out RedNotes Plus (which is currently in its minimal viable product state), feel free to do so in the release section! The application you'll find there is meant to illustrate the direction in which the software is going.
32+
2833
## Planned features/TODO
2934

3035
- Canvas panning restrictions
@@ -43,6 +48,24 @@ a simple, intuitive yet powerful note-taking software.
4348
- Allow changing toolbar positions
4449
- Rust rewrite of the SVG generation
4550

51+
## Credits
52+
53+
RedNotes Plus wouldn't be possible without...
54+
55+
- [Svelte](https://svelte.dev), the front-end framework!
56+
- [Tauri](https://tauri.app), the library this software was created with!
57+
- [Tailwindcss](https://tailwindcss.com), drastically simplifying CSS!
58+
- [Catppuccin (mocha)](https://catppuccin.com/), the color palette!
59+
- [Vite](https://vite.dev), the bundler for Tailwind and Svelte!
60+
- [Tabler Icons](https://tabler.io/icons), the source of the icons used throughout this software!
61+
- Many friends giving me feedback and feature suggestions along the way!
62+
63+
### Use of AI
64+
65+
I have used AI models to help me research what it means to make a user-friendly
66+
note-taking app and to inform me on how to implement some features, like
67+
a pressure-sensitive pen input. I have written all the code myself though!
68+
4669
## License
4770

4871
RedNotes Plus is licensed under the MIT license. Any credit when using it is

0 commit comments

Comments
 (0)