Skip to content

Commit b1283b6

Browse files
committed
Create STATUS.md
1 parent b99f60c commit b1283b6

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

server/STATUS.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Atomic-Server status & Feature stability
2+
3+
If you're contemplating to use Atomic-Server in a prodcution environment, you'll want to know to what extend you could rely on this project.
4+
Some features are prone to change, whilst others are already fully working as intended.
5+
This document describes the current status of Atomic-Server, and specifically which features are stable, and which are not.
6+
7+
## Stable
8+
9+
These features are very unlikely to be significantly altered until V1.0. They will also not be dropped.
10+
11+
- HTTP Resource fetching.
12+
- JSON-AD serialization / parsing.
13+
- TLS / HTTPS setup.
14+
- WebSockets. Some features may be added, but for most use cases the current implementation works great.
15+
- Commits. There may be changes in the signature algorithm or the likes, but I don't expect much changes.
16+
- Storage + migration system. Upgrading your Atomic-Server should not lead to data loss. Migrations are fully automated.
17+
18+
## Likely to change
19+
20+
- Endpoint API. Currently only supports GET requests.
21+
- Collections / Queries. Relatively stable, but still lacks some important features (like having multiple filters in one Query).
22+
- Cookie Authentication.
23+
- Document editor, see [milestone](https://github.com/atomicdata-dev/atomic-data-browser/milestone/2).
24+
- Table editor, see [milestone](https://github.com/atomicdata-dev/atomic-data-browser/milestone/3).
25+
- URL requirements for new URLS, see [issue](https://github.com/atomicdata-dev/atomic-data-rust/issues/556)
26+
- Full text search. Improvements to sorting algorithm and adding more filter options is likely.
27+
28+
## Experimental
29+
30+
- Plugin system. All APIs related to this are very likely to change. See [issue](https://github.com/atomicdata-dev/atomic-data-rust/issues/73)
31+
- Chat rooms. They work, but expect serious changes.

0 commit comments

Comments
 (0)