Skip to content

Commit 0332f8c

Browse files
authored
Update README.md.
1 parent afa9623 commit 0332f8c

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,23 @@
1-
# Markocoa
2-
C# Tool for generating lightweight static websites from MarkDown files.
1+
# Markocoa 🍫
2+
Markocoa is a C# static site generator that utilizes markdown files to create lightweight, customizable websites.
3+
4+
[Looking for an example?](https://www.tweety-lab.dev/)
5+
6+
## Installation
7+
Markocoa can be installed globally as a dotnet tool by running:
8+
9+
```terminal
10+
dotnet tool install Markocoa --global
11+
```
12+
13+
Once installed, simply type `Markocoa` in your terminal to start using it.
14+
15+
## Default commands
16+
You can view help for a command by running it with no parameters.
17+
18+
| Command | Purpose |
19+
|------------|-----|
20+
| `new` | Creates a new template project. |
21+
| `build` | Compiles a project into a website. |
22+
| `host` | Provides a live preview of the project. |
23+
| `deploy` | Automatically deploys the site to a web-host (like GitHub Pages). |

0 commit comments

Comments
 (0)