Skip to content

Commit dcc45f0

Browse files
update readme
1 parent 2418647 commit dcc45f0

File tree

2 files changed

+33
-20
lines changed

2 files changed

+33
-20
lines changed

README.md

Lines changed: 33 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,48 @@
11
<p align="center">
2-
<img src="res/readme.png"/>
3-
<img src="https://img.shields.io/github/actions/workflow/status/astudentinearth/darkwrite/tscheck.yml?label=tests&style=for-the-badge"/>
2+
<img src="res/cover.png"/>
3+
<img src="https://img.shields.io/github/actions/workflow/status/astudentinearth/darkwrite/test-unit.yml?label=tests&style=for-the-badge"/>
44
<img src="https://img.shields.io/github/license/astudentinearth/darkwrite?style=for-the-badge"/>
55
<img src="https://img.shields.io/github/stars/astudentinearth/darkwrite?color=yellow&style=for-the-badge"/>
6-
<img src="https://img.shields.io/badge/-WINDOWS-blue?logo=windows11&style=for-the-badge"/>
7-
<img src="https://img.shields.io/badge/-mac-black?logo=apple&style=for-the-badge"/>
8-
<img src="https://img.shields.io/badge/-linux-gray?logo=linux&style=for-the-badge&logoColor=white"/>
96
<img src="https://img.shields.io/github/v/tag/astudentinearth/darkwrite?style=for-the-badge"/>
107
</p>
8+
<strong>
9+
<p align="center">
10+
<a href="https://twitter.com/codingwithburak">Follow on Twitter</a> -
11+
<a href="https://github.com/astudentinearth/darkwrite/releases">Download Darkwrite</a> -
12+
<a href="https://github.com/astudentinearth/darkwrite/issues">Report bugs</a>
13+
</p>
14+
</strong>
15+
16+
# 📓Notes and todo, the way you want.
17+
18+
✒️ Darkwrite is a simple and easy way to organize your notes and todos. It was developed with the user in mind, where personalization plays a key role.
19+
20+
🛠️ Darkwrite is currently in alpha, basic features are available, however bugs are likely to happen and there is still a lot to work on. Head over to the [releases page](https://github.com/astudentinearth/darkwrite/releases) to get started.
21+
22+
⭐Star this repository to know when we release new updates.
1123

24+
## 🖊️ Easy to use and rich editor
1225

13-
# Notes and todo, the way you want.
14-
[Follow me on Twitter](https://twitter.com/codingwithburak)
15-
Darkwrite is a simple and easy way to organize your notes and todos. It was developed with the user in mind, where personalization plays a key role.
16-
Darkwrite is currently in alpha, basic features are available, however bugs are likely to happen and there is still a lot to work on. To download the alpha, go to the [releases page.](https://github.com/astudentinearth/darkwrite/releases).
17-
Star this repository to know when we release new updates.
18-
## Easy to use and rich editor
19-
Darkwrite features a rich editor which supports formatting, headings, todo lists, numbered lists, links and much more.
26+
🖋️ Unleash the power of a rich editor which supports formatting, headings, todo lists, numbered lists, links and much more.
2027

21-
## Themes
22-
Darkwrite supports custom themes, and comes with a selection of them by default.
28+
## 🖌️ Make it yours.
2329

24-
## Fonts
25-
Darkwrite lets you use the fonts you wish. You can change the user interface font; sans, serif and monospace fonts for your notes; or choose custom fonts on a per-note basis.
30+
🎨 Choose from the selection of included themes - or create your own. Say goodbye to the boring light and dark themes.
31+
✒️ Pick the fonts you like. You can change the default styles for your notes or choose a font you like only for one specific note. You can also change the user interface font and everything else will follow suit.
32+
33+
## 🔒 Open and private.
34+
35+
👨‍💻 Darkwrite's source code is right here. It does not collect any of your data. All your notes are stored locally on your device.
36+
📦 You are never locked in. Export all your notes as HTML files, and you can use them anywhere else. Need to backup your data? No problem. Get an archive with just one click and restore them later if you need it.
37+
38+
## Docs
39+
40+
- [Building Darkwrite](docs/BUILDING.md)
41+
- [Development docs](docs/DEVELOPMENT.md)
2642

27-
## Docs
28-
- [Building Darkwrite](docs/BUILDING.md)
29-
- [Development docs](docs/DEVELOPMENT.md)
30-
3143
For everything else, see [the docs folder](docs)
3244

3345
## License
46+
3447
Darkwrite is free and open source, licensed under GNU Affero General Public License, version 3 or any later version at your option.
3548
Licenses for 3rd party packages used to make Darkwrite possible can be found [here.](https://github.com/astudentinearth/darkwrite/blob/dev/packages/app-desktop/THIRDPARTY.txt)

res/cover.png

392 KB
Loading

0 commit comments

Comments
 (0)