Skip to content

Commit 0bb3f55

Browse files
committed
Improve readme
1 parent 4e571ab commit 0bb3f55

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ _Status: Beta. [Status](server/STATUS.md) specifies which features are stable. [
1717
**Atomic-server is a graph database server for storing and sharing [Atomic Data](https://docs.atomicdata.dev/).
1818
Demo on [atomicdata.dev](https://atomicdata.dev)**
1919

20-
- 🚀 **Fast** (1ms median response time on my laptop), powered by [actix-web](https://github.com/actix/actix-web) and [sled](https://github.com/spacejam/sled)
20+
- 🚀 **Fast** (less than 1ms median response time on my laptop), powered by [actix-web](https://github.com/actix/actix-web) and [sled](https://github.com/spacejam/sled)
2121
- 🪶 **Lightweight** (8MB download, no runtime dependencies)
2222
- 💻 **Runs everywhere** (linux, windows, mac, arm)
2323
- ⚛️ **Dynamic schema validation** / type checking using [Atomic Schema](https://docs.atomicdata.dev/schema/intro.html).
@@ -32,7 +32,7 @@ Demo on [atomicdata.dev](https://atomicdata.dev)**
3232
- 📲 **Invite and sharing system** with [Atomic Invites](https://docs.atomicdata.dev/invitations.html)
3333
- 📂 **File management**: Upload, download and preview attachments.
3434
- 🖥️ **Desktop app**: Easy desktop installation, with status bar icon, powered by [tauri](https://github.com/tauri-apps/tauri/).
35-
35+
- 📚 **Libraries**: [Javascript / Typescript](https://www.npmjs.com/package/@tomic/lib), [React](https://www.npmjs.com/package/@tomic/react), [Svelte](https://www.npmjs.com/package/@tomic/svelte)
3636
Powered by Rust, [atomic-lib](https://crates.io/crates/atomic-lib) and [more](Cargo.toml).
3737
[→ Read more](server/README.md)
3838

server/README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ _Status: alpha. [Breaking changes](../CHANGELOG.md) are expected until 1.0._
1111
Demo on [atomicdata.dev](https://atomicdata.dev)**
1212

1313
<!-- We re-use this table in various places, such as ../README.md and in the docs repo. Consider this the source. -->
14-
- 🚀 **Fast** (1ms median response time on my laptop), powered by [actix-web](https://github.com/actix/actix-web) and [sled](https://github.com/spacejam/sled)
14+
- 🚀 **Fast** (less than 1ms median response time on my laptop), powered by [actix-web](https://github.com/actix/actix-web) and [sled](https://github.com/spacejam/sled)
1515
- 🪶 **Lightweight** (8MB download, no runtime dependencies)
1616
- 💻 **Runs everywhere** (linux, windows, mac, arm)
1717
- ⚛️ **Dynamic schema validation** / type checking using [Atomic Schema](https://docs.atomicdata.dev/schema/intro.html).
@@ -26,6 +26,7 @@ Demo on [atomicdata.dev](https://atomicdata.dev)**
2626
- 📲 **Invite and sharing system** with [Atomic Invites](https://docs.atomicdata.dev/invitations.html)
2727
- 📂 **File management**: Upload, download and preview attachments.
2828
- 🖥️ **Desktop app**: Easy desktop installation, with status bar icon, powered by [tauri](https://github.com/tauri-apps/tauri/).
29+
- 📚 **Libraries**: [Javascript / Typescript](https://www.npmjs.com/package/@tomic/lib), [React](https://www.npmjs.com/package/@tomic/react), [Svelte](https://www.npmjs.com/package/@tomic/svelte)
2930

3031
Powered by Rust, [atomic-lib](https://crates.io/crates/atomic-lib) and [more](Cargo.toml).
3132

@@ -64,18 +65,19 @@ https://user-images.githubusercontent.com/2183313/139728539-d69b899f-6f9b-44cb-a
6465

6566
## When should you use this
6667

67-
- You want a powerful, lightweight, fast and easy to use **CMS** with editors, modelling capabilities and an intuitive API
68+
- You want a powerful, lightweight, fast and easy to use **CMS or database** with live updates, editors, modelling capabilities and an intuitive API
69+
- You want to build a webapplication, and like working with using [React](https://github.com/atomicdata-dev/atomic-data-browser) or [Svelte](https://github.com/atomicdata-dev/atomic-svelte).
6870
- You want to make (high-value) **datasets as easily accessible as possible**
6971
- You want to specify and share a **common vocabulary** / ontology / schema for some specific domain or dataset. Example classes [here](https://atomicdata.dev/classes).
7072
- You want to use and **share linked data**, but don't want to deal with most of [the complexities of RDF](https://docs.atomicdata.dev/interoperability/rdf.html), SPARQL, Triple Stores, Named Graphs and Blank Nodes.
7173
- You are interested in **re-decentralizing the web** or want want to work with tech that improves data ownership and interoperability.
72-
- You like living on the edge (this application is not production ready)
7374

7475
## When _not_ to use this
7576

76-
- If you need **stability**, look further (for now). This is beta sofware and is prone to change.
77-
- You're dealing with **sensitive / private data**. The authorization mechanisms are relatively new and not rigorously tested.
78-
- **Complex query requirements**. Check out NEO4j, Apache Jena or maybe TerminusDB.
77+
- High-throughput **numerical data / numerical analysis**. Atomic-Server does not have aggregate queries.
78+
- If you need **high stability**, look further (for now). This is beta sofware and can change.
79+
- You're dealing with **very sensitive / private data**. The built-in authorization mechanisms are relatively new and not rigorously tested. The database itself is not encrypted.
80+
- **Complex query requirements**. We have queries with filters and features for path traversal, but it may fall short. Check out NEO4j, Apache Jena or maybe TerminusDB.
7981

8082
## Installation & getting started
8183

@@ -187,15 +189,17 @@ ATOMIC_SERVER_URL=https://example.com
187189

188190
### Using `systemd` to run Atomic-Server as a service
189191

190-
In Unix operating systems, you can use `systemd` to manage a
192+
In Linux operating systems, you can use `systemd` to manage running processes.
193+
You can configure it to restart automatically, and collect logs with `journalctl`.
191194

192195
Create a service:
193196

194197
```sh
195-
vim /etc/systemd/system/atomic.service
198+
nano /etc/systemd/system/atomic.service
196199
```
197200

198-
Paste this:
201+
Add this to its contents, make changes if needed:
202+
199203
```
200204
[Unit]
201205
Description=Atomic-Server
@@ -216,15 +220,11 @@ WantedBy=multi-user.target
216220
```
217221

218222
```sh
219-
# start service
223+
# start / status / restart commands:
220224
systemctl start atomic
221-
# check status
222225
systemctl status atomic
223-
# restart
224226
systemctl restart atomic
225-
# logs
226-
journalctl -u atomic.service
227-
# logs, since one hour, follow
227+
# show recent logs, follow them on screen
228228
journalctl -u atomic.service --since "1 hour ago" -f
229229
```
230230
## Usage

0 commit comments

Comments
 (0)