Update README.md
Signed-off-by: mellobacon <42365887+mellobacon@users.noreply.github.com>
mellobacon committed
Oct 2, 2023 at 18:32 UTC
dc94c3a9a35322ace045ea7c1faa406f676ebc20
1 file changed
+40
-8
README.md
+40
-8
@@ -1,17 +1,24 @@
1
-<h1 align="center" style="position: relative;">
1
+<p align="center">
2
<img width="200" src="./public/assets/images/Icon(1).png" alt="The nucleus icon" /><br>
3
- Nucleus
3
+</p>
4
+
5
+<h1 align="center">
6
+Nucleus
7
</h1>
5
-<h3 align="center">
8
+
9
+<p align="center">
10
<img alt="GitHub issues" src="https://img.shields.io/github/issues/mellobacon/Nucleus?style=for-the-badge">
11
<img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/mellobacon/Nucleus?style=for-the-badge">
12
<img alt="GitHub closed pull requests" src="https://img.shields.io/github/issues-pr-closed-raw/mellobacon/Nucleus?style=for-the-badge">
13
<img alt="Project License" src="https://img.shields.io/github/license/mellobacon/Nucleus?style=for-the-badge">
14
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/mellobacon/Nucleus?style=for-the-badge">
11
- <img alt="GitHub Hacktoberfest combined status" src="https://img.shields.io/github/hacktoberfest/2022/mellobacon/Nucleus?style=for-the-badge">
12
-
13
- A text editor with better UI than [enter funny thing here]
14
- </h3>
15
+ <img alt="Static Badge" src="https://img.shields.io/badge/Hacktoberfest-Participating-brightgreen?style=for-the-badge">
16
+</p>
17
+
18
+<h3 align="center">
19
+A text editor with better UI than [enter funny thing here]
20
+</h3>
21
+
22
<p align="center">
23
<a href="https://github.com/mellobacon/Nucleus/blob/d704ed7892344480fb6fcd3c94ef534f52cadc31/LICENSE">License</a> •
24
<a href="https://github.com/mellobacon/Nucleus/releases">Download</a>
@@ -26,9 +33,34 @@ Nucleus is a text editor featuring a clean and easy to use user interface inspir
33
34
<img width="600" alt="nucleus_emptyworkspace" src="https://github.com/mellobacon/Nucleus/assets/42365887/b66b6f69-218f-4aab-8ae2-d2c4c1b87203">
35
36
+### Current Rewrite Progress
37
+
38
+✅ = Implemented
39
+
40
+🟡 = In Progress
41
+
42
+⭕ = Not Yet Implemented
43
+
44
+✅* = Implemented but limited for now
45
+
46
+#### General Features
47
+
48
+| Feature | Progress |
49
+|---------------------|----------|
50
+| File Tree | ✅ |
51
+| Syntax Highlighting | ⭕ |
52
+| Logging | 🟡 |
53
+| Theming | ✅* |
54
+| Notifications | ⭕ |
55
+| Settings | ✅* |
56
+| Context Menus | ✅ |
57
+| Internal Terminal | ⭕ |
58
+| Editor | ✅ |
59
+
60
+
61
### Known issues
62
31
-- TBA
63
+- Opening a file has a chance to freeze the file tree. Temp workaround is to just close and reopen the sidebar.
64
65
## Contributing
66