summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNaz <ndpm13@ch-naseem.com>2025-09-15 21:47:00 +0100
committerNaz <ndpm13@ch-naseem.com>2025-09-15 21:47:00 +0100
commitc36a5add150f96917ab1b1583af69d1e0750173c (patch)
tree95b603eaac534c9550b217ab4994d9ec599b26b6 /README.md
parent622efeecab084c0a036be83def306b9c19f6e7e8 (diff)
📚docs: add compose.yml for ref and update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8d1c1d6..ec92b44 100644
--- a/README.md
+++ b/README.md
@@ -8,10 +8,25 @@ Simple but customizable solution for storing your Browser bookmarks.
## Installation
+### Cargo
+
```sh
cargo install --git https://github.com/ndpm13/sbm-rs
```
+### Compose file
+
+```yml
+services:
+ sbm-rs:
+ container_name: sbm-rs
+ image: ghcr.io/ndpm13/sbm-rs:0.1.0
+ volumes:
+ - ./config:/root/.config/sbm-rs
+ ports:
+ - "8080:8080"
+```
+
## Usage
Configuration files for sbm-rs are stored by default in
@@ -69,7 +84,7 @@ theme:
## To-Do List
- [ ] CLI for managing bookmarks
-- [ ] Container image
+- [*] Container image
- [ ] Browser extension
## License