owl-blogs/README.md

37 lines
565 B
Markdown
Raw Permalink Normal View History

2022-08-15 19:06:17 +00:00
![Mascot](assets/owl.png)
2022-08-03 14:49:17 +00:00
# Owl Blogs
2022-11-01 21:00:01 +00:00
A simple web server for blogs generated from Markdown files.
**_This project is not yet stable. Expect frequent breaking changes! Only use this if you are willing to regularly adjust your project accordingly._**
2022-08-03 15:56:13 +00:00
2024-02-25 19:29:41 +00:00
## Build
```
CGO_ENABLED=1 go build -o owl ./cmd/owl
```
## Run
To run the web server use the command:
```
owl web
```
The blog will run on port 3000 (http://localhost:3000)
To create a new account:
```
owl new-author -u <name> -p <password>
```
To retrieve a list of all commands run:
```
owl -h
```