Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
strawmelonjuice committed Sep 10, 2024
1 parent b4ad003 commit bbc54f2
Showing 1 changed file with 26 additions and 12 deletions.
38 changes: 26 additions & 12 deletions README.MD
Original file line number Diff line number Diff line change
@@ -1,24 +1,38 @@
# Cynthia!(.rs)

- Generating websites
- Serving them
- Using a simple file-based content management system (CMS)
<font style="color: red"><b>

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.
<font style="color: red; font-weight: bold">
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>

## usage

Firstly, you need to install the package. You can do this by running the following command:

```bash
cargo install cynthiaweb
```

After that, you can run the following command to generate a new website:

</font></b>
```bash
md abc
cd abc
cynthiaweb init
```

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>.
The initialisation wizard will ask you a few questions about your website, and then generate the necessary files for you.

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!).)
You can then run the following command to serve your website:

The philosophy?
```bash
cynthiaweb start
```

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

Sure, WordPress can be useful, and can be the best way to set up your website.
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).
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.
## Getting started
You'll of course need to forward Cynthia to the web, which you can do with a reverse proxy like Nginx or Apache.

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

0 comments on commit bbc54f2

Please sign in to comment.