Skip to content

Commit bbc54f2

Browse files
Update readme
1 parent b4ad003 commit bbc54f2

File tree

1 file changed

+26
-12
lines changed

1 file changed

+26
-12
lines changed

README.MD

+26-12
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,38 @@
11
# Cynthia!(.rs)
2+
23
- Generating websites
34
- Serving them
45
- Using a simple file-based content management system (CMS)
5-
<font style="color: red"><b>
66

7-
Cynthia is in active development, but not ready for full production usage! It has some releases for testing, but none are marked as 'ready' at the moment.
7+
<font style="color: red; font-weight: bold">
8+
Cynthia is currently in development, and is not yet ready for use. Cynthia is semantically versioned, which means no huge breaks should be expected between MAJOR versions. In the minor versions, however... Cynthia is not nearly done getting new features!</font>
9+
10+
## usage
11+
12+
Firstly, you need to install the package. You can do this by running the following command:
13+
14+
```bash
15+
cargo install cynthiaweb
16+
```
17+
18+
After that, you can run the following command to generate a new website:
819

9-
</font></b>
20+
```bash
21+
md abc
22+
cd abc
23+
cynthiaweb init
24+
```
1025

11-
This page is either found on [/p/about/](/p/about/) in your fresh Cynthia install, or on <https://github.com/strawmelonjuice/CynthiaCMS-JS/blob/main/README.MD>.
26+
The initialisation wizard will ask you a few questions about your website, and then generate the necessary files for you.
1227

13-
Cynthia is an alternative to the engine I built to host <https://strawmelonjuice.com/>. (The original engine is built on a mix of PHP and javascript, Cynthia is pure Rust (yes, Rust!).)
28+
You can then run the following command to serve your website:
1429

15-
The philosophy?
30+
```bash
31+
cynthiaweb start
32+
```
1633

17-
> Why use a database if your content is mostly static? Why use an admin panel if you have file access?
34+
Or bind it to a service.
1835

19-
Sure, WordPress can be useful, and can be the best way to set up your website.
20-
But if you like tinkering about with configuration files and like writing your pages in markdown (yes, that's Cynthia's default format!), then join the Cynthia side (basically Jekyll but less... Jekyll, and no Ruby).
21-
Oh! Aaand, for those who like using a panel or app to change their site, yes. It will come. But opt-in, not opt-out.
22-
## Getting started
36+
You'll of course need to forward Cynthia to the web, which you can do with a reverse proxy like Nginx or Apache.
2337

24-
_The docs for this will come, when cynthia is ready for usage!_
38+
More documentation will be available on <https://cynthia-docs.strawmelonjuice.com>!

0 commit comments

Comments
 (0)