Skip to content

Commit 3119118

Browse files
authored
Update README by removing features and safety warning
Removed safety warning and features section from README.
1 parent 26f145b commit 3119118

1 file changed

Lines changed: 13 additions & 11 deletions

File tree

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,18 @@ A serverless, database-free CMS built on Git plumbing.
66
77
**git-cms** treats your Git repository as a distributed, cryptographically verifiable database. Instead of files, it stores content as commit messages on "empty trees," creating a linear, append-only ledger for articles, comments, or any other structured data.
88

9-
## ⚠️ SAFETY WARNING
9+
## Features
10+
11+
- **Database-Free:** No SQL, No NoSQL. Just Git objects (Merkle DAG).
12+
- **Fast-Forward Only:** Enforces strict linear history for provenance.
13+
- **Atomic Publishes:** "Publishing" is just a pointer update (CAS).
14+
- **Infinite History:** Every draft save is a commit. Scrub back to any point in time.
15+
16+
## Development
17+
18+
### ⚠️ SAFETY WARNING
19+
20+
We use Docker Compose to ensure a consistent, safe environment.
1021

1122
**If you clone this repo and want to run the tests, ALWAYS run them in Docker.**
1223

@@ -18,16 +29,7 @@ npm test
1829
# (This automatically runs ./test/run-docker.sh)
1930
```
2031

21-
## Features
22-
23-
- **Database-Free:** No SQL, No NoSQL. Just Git objects (Merkle DAG).
24-
- **Fast-Forward Only:** Enforces strict linear history for provenance.
25-
- **Atomic Publishes:** "Publishing" is just a pointer update (CAS).
26-
- **Infinite History:** Every draft save is a commit. Scrub back to any point in time.
27-
28-
## Development
29-
30-
We use Docker Compose to ensure a consistent, safe environment.
32+
<img width="500" alt="Burnt-Out Linux Penguin" src="https://github.com/user-attachments/assets/87d61150-2f57-47f5-9705-46f8399377d0" align="left" />
3133

3234
### Start the Server (Dev Mode)
3335
```bash

0 commit comments

Comments
 (0)