Skip to content

Commit 2e33ae7

Browse files
committed
This repo is now called noteground
1 parent d9e6773 commit 2e33ae7

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Personal Notes — WordPress Playground
1+
# Noteground - personal notes running locally on WordPress Playground
22

3-
A Notion-like personal knowledge base running locally via [WordPress Playground](https://wordpress.github.io/wordpress-playground/). No PHP installation, no database daemon, no web server configuration required — WordPress runs entirely in your browser.
3+
A personal knowledge base running locally via [WordPress Playground](https://wordpress.github.io/wordpress-playground/). No PHP installation, no database daemon, no web server configuration required — WordPress runs entirely in your browser.
44

5-
This repo is public, but your notes live in a separate **private** Git repository that you clone locally as `./data/`.
5+
This repo is public, but your notes live in a separate **private** Git repository that you clone locally via the scripts provided.
66

7-
Note that there is [a proposal](https://adamadam.blog/2025/01/08/wordpress-as-a-git-repo/) from Adam Zieliński to make it possible for WordPress Playground to have content stored as Markdown files.
7+
Note that there is [a proposal](https://adamadam.blog/2025/01/08/wordpress-as-a-git-repo/) from Adam Zieliński to make it possible for WordPress Playground to have content stored as Markdown files.
88
You can [follow the discussion on GitHub](https://github.com/WordPress/wordpress-playground/discussions/1524) about this, but it is not yet officially supported.
99

1010
## Quickstart
@@ -17,8 +17,8 @@ You can [follow the discussion on GitHub](https://github.com/WordPress/wordpress
1717
### Clone this repo and install dependencies
1818

1919
```bash
20-
git clone <this-repo-url>
21-
cd scratch-wordpress
20+
git clone git@github.com:snim2/noteground.git
21+
cd noteground
2222
./script/setup
2323
```
2424

@@ -51,8 +51,8 @@ This commits the database and media library to your private repo and pushes.
5151
## Restoring notes on a new machine
5252

5353
```bash
54-
git clone <this-repo-url>
55-
cd scratch-wordpress
54+
git clone git@github.com:snim2/noteground.git
55+
cd noteground
5656
./script/setup
5757
git clone git@github.com:you/notes-data.git data
5858
./script/start
@@ -114,7 +114,7 @@ Create a gitignored `blueprint-local.json` to customise your local setup without
114114
## How privacy works
115115

116116
```plaintext
117-
scratch-wordpress/ ← this repo (public)
117+
noteground/ ← this repo (public)
118118
└── data/ ← your private repo, cloned here (gitignored)
119119
├── database/
120120
│ └── .ht.sqlite ← SQLite database with all your notes

0 commit comments

Comments
 (0)