diff --git a/README.md b/README.md index 6f8a3b0..ef0f007 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,31 @@ A (somewhat barebones) atproto app for creating custom sites without hosting! - Web GUI **will be** located at [`./web-gui`](./web-gui/) - Fuse tool **will be** located at [`./fuse`](./fuse/) -TODO: +## How to: + +**View someones site?** +Head to `https://.atcities.dev/` or `https://.did-.atcities.dev/`. + +**Upload your own site?** +Use the upload cli. Installation guide below. + +**Self host atcities.dev?** +Clone this repo and setup the `.env` file for `/server`, then \ + +### CLI installation guide. + +1. Build from source: + Prerequisites: `git` `cargo` `rust` + ```sh + git clone https://tangled.org/@vielle.dev/atcities.dev + cd atcities.dev/upload + cargo build + sudo cp ./target/debug/atcities-upload /bin + # Reload your shell environment + atcities-upload --version + ``` + +## Todo: - [x] Resolve `handle.host` and `did.did-method.host` domains to records/blobs - [x] Backfill network @@ -16,9 +40,9 @@ TODO: - [x] Store blobs for CDN (max ~0.25gb per user) - [x] Moderate illegal content or hope that people are niceys (Hope that people are niceys) -- [ ] Finish CLI tool - - [ ] Sign in via app password - - [ ] Clear old site - - [ ] Upload new site +- [x] Finish CLI tool + - [x] Sign in via app password + - [x] Clear old site + - [x] Upload new site - [ ] Fuse uploader - [ ] Web GUI uploader