chore(docs): updated readme
Signed-off-by: mellobacon <mellodev@outlook.com>
mellobacon committed
Nov 6, 2023 at 23:47 UTC
c80df598ea360198554d36a8ada7178ffb8d5354
1 file changed
+16
-9
README.md
+16
-9
@@ -7,31 +7,33 @@ Nucleus
7
</h1>
8
9
<p align="center">
10
+ <img alt="Build Status" src="https://img.shields.io/github/actions/workflow/status/mellobacon/Nucleus/.github%2Fworkflows%2Fpublish.yml?style=for-the-badge">
11
<img alt="GitHub issues" src="https://img.shields.io/github/issues/mellobacon/Nucleus?style=for-the-badge">
12
<img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/mellobacon/Nucleus?style=for-the-badge">
13
<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">
15
- <img alt="Static Badge" src="https://img.shields.io/badge/Hacktoberfest-Participating-brightgreen?style=for-the-badge">
15
+ <img alt="Release Version" src="https://img.shields.io/github/v/tag/mellobacon/Nucleus?style=for-the-badge&label=Current">
16
+ <img alt="Project License" src="https://img.shields.io/github/license/mellobacon/Nucleus?style=for-the-badge">
17
</p>
18
19
<h3 align="center">
19
-A text editor with better UI than [enter funny thing here]
20
-</h3>
21
-
22
-<p align="center">
20
<a href="https://github.com/mellobacon/Nucleus/blob/d704ed7892344480fb6fcd3c94ef534f52cadc31/LICENSE">License</a> •
24
- <a href="https://github.com/mellobacon/Nucleus/releases">Download</a>
25
-</p>
21
+ <a href="https://github.com/mellobacon/Nucleus/releases">Download</a> •
22
+ <a href="https://github.com/mellobacon/Nucleus/blob/master/CONTRIBUTING.md">How to Contribute</a> •
23
+ <a href="https://github.com/mellobacon/Nucleus/blob/master/CODE_OF_CONDUCT.md">Code of Conduct</a>
24
+</h3>
25
26
___
27
28
Please note that Nucleus is currently being rewritten. Features are being reworked and will be added again later. Refer to PR [#59](https://github.com/mellobacon/Nucleus/pull/59).
29
___
30
31
+
32
+<img width="100%" alt="nucleus_emptyworkspace" src="https://github.com/mellobacon/Nucleus/assets/42365887/b66b6f69-218f-4aab-8ae2-d2c4c1b87203">
33
+
34
Nucleus is a text editor featuring a clean and easy to use user interface inspired by Visual Studio Code, Atom, Fleet, and others.
35
34
-<img width="600" alt="nucleus_emptyworkspace" src="https://github.com/mellobacon/Nucleus/assets/42365887/b66b6f69-218f-4aab-8ae2-d2c4c1b87203">
36
+___
37
38
### Current Rewrite Progress
39
@@ -62,6 +64,11 @@ Nucleus is a text editor featuring a clean and easy to use user interface inspir
64
65
- N/A
66
67
+## How to Install
68
+Download the most recent build of Nucleus [from the Release page](https://github.com/mellobacon/Nucleus/releases).
69
+
70
+**Note: Windows Only (for now)*
71
+
72
## Contributing
73
74
This is for those that want to contribute or build on their local machines. [Here's how to contribute](https://github.com/mellobacon/Nucleus/blob/master/CONTRIBUTING.md).