Merge pull request #177 from ember-nexus/chore/update-readme

Update readme and docker image labels.

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+### Changed
+- Update readme and docker image labels.
 
 ## 0.0.35 - 2023-10-26
 

README.md

@@ -1,39 +1,51 @@
-# Ember Nexus: A Powerful API for the Modern Web
+# Ember Nexus: Knowledge Graph API
+
+Store anything, connect everything, search it all? Sure thing! 😃
 
 Ember Nexus API is a dynamic and versatile REST-API that leverages the power of graphs to provide flexible and secure
-data storage and retrieval for modern web applications.
+data storage and retrieval for data-minded people. It is open source and can be hosted on your own hardware - we
+currently support AMD and ARM architectures.
 
 ## Quick Links
 
-- [Explore the code on GitHub](https://github.com/ember-nexus/api)
+- [Getting Started](https://ember-nexus.github.io/api/#/getting-started/tech-stack)
 - [Check out the documentation](https://ember-nexus.github.io/api)
 - [Find us on Docker Hub](https://hub.docker.com/r/embernexus/api)
 
+Find us on [GitHub](https://github.com/ember-nexus/api), [our website ember-nexus.dev](https://ember-nexus.dev), and
+[Discord](https://discord.gg/3UhupSvMAa).
+
 ## Features
 
 Ember Nexus offers a range of cutting-edge features to meet your data storage needs, including:
 
-- **Graph-Based Data Model**: Ember Nexus uses an internal graph database to enable easy connections between data
-  elements, so you can build sophisticated and scalable applications.
-- **Flexible User-Defined Schemas**: With Ember Nexus, you can define your own custom schemas for your data, in
-  addition to static schemas that are built in for security reasons.
-- **UUIDs for All**: Ember Nexus assigns a UUID to every storable element, making it easy to retrieve and manage data.
-- **Near Real-Time Search**: Ember Nexus supports full-text search that is fast and responsive.
-- **Custom Graph Queries**: With Ember Nexus, you can write custom graph queries using Cypher to get the exact data
-  you need.
-- **WebDAV Support**: Ember Nexus makes it easy to use WebDAV to manage your data.
-- **Web Hooks**: Ember Nexus also supports web hooks, so you can trigger actions or events based on changes in your
-  data.
+- **Graph-based data model**: Ember Nexus uses the graph database [Neo4j](https://neo4j.com/) internally, which enables
+  you to connect any data element to any other data element and efficiently search long and recursive relations.
+- **Access through UUID**: Ember Nexus assigns a UUID to every storable element, making it easy to retrieve and manage
+  data. User can provide their own UUIDs as well, although this feature is disabled by default.
+- **Near real-time search**: Ember Nexus supports full-text search that is fast and responsive. Most of
+  [Elasticsearch](https://www.elastic.co/elasticsearch/)'s features are directly available while not bypassing the
+  security model.
+- **Secure by default**: User-created data is only visible to the owner by default. Sharing data requires explicit
+  rules, which are recursive and optionally limited in access scope and other features.
+- **High-quality software**: We invested quite a bit of time to make sure that this software is as stable as possible.
+  We employ code linters, unit tests, feature tests, memory leak tests, mutant tests, and more. Most examples in the
+  documentation are automatically checked for deprecations.
+
+## Planned Features
+
+See our [milestone](https://github.com/ember-nexus/api/milestones) and
+[issue](https://github.com/ember-nexus/api/issues) list on GitHub for planned features.
 
-## Use Cases
+## When should I use Ember Nexus API?
 
 Ember Nexus is a powerful tool for a range of use cases, including:
 
-- **Private Cloud**: Use Ember Nexus to create your own private cloud, similar to Nextcloud.
+- **Private cloud**: Use Ember Nexus to create your own private cloud, similar to Nextcloud.
 - **Websites**: Use Ember Nexus as a CMS or blog platform.
-- **Data Management Systems**: Ember Nexus is ideal for building data management systems and archives.
-- **Data Lakes**: Ember Nexus makes it easy to create data lakes, where you can store and manage large volumes of data.
-- **Interface Between Multiple Systems**: Ember Nexus can serve as a bridge between multiple systems, making it easy
-  to integrate and manage data across your entire infrastructure.
+- **Data management systems**: Ember Nexus is ideal for building data management systems and archives.
+- **Data lakes**: Ember Nexus makes it easy to create data lakes, where you can store and manage large volumes of data.
+- **Interface between multiple systems**: Ember Nexus can serve as a bridge between multiple systems, making it easy to
+  integrate and manage data across your entire infrastructure.
 
 Experience the power of Ember Nexus for yourself - [try it out today](https://ember-nexus.github.io/api/#/)!

docker/Dockerfile

@@ -270,8 +270,8 @@ LABEL org.opencontainers.image.vendor="Ember Nexus" \
     org.opencontainers.image.authors="Sören Klein / Syndesi <[email protected]>" \
     org.opencontainers.image.licenses="GPL-3.0-only" \
     org.opencontainers.image.source="https://github.com/ember-nexus/api" \
-    org.opencontainers.image.title="Ember Nexus: API" \
-    org.opencontainers.image.description="Flexible graph based API for the modern web."
+    org.opencontainers.image.title="API" \
+    org.opencontainers.image.description="Knowledge Graph API."
 # The environment variable VERSION is set to dev by default, only release builds get their actual release version set.
 # Background: If the en user uses the dev mode, it is epected that he knows what he does.
 ARG VERSION=dev
@@ -338,8 +338,8 @@ LABEL org.opencontainers.image.vendor="Ember Nexus" \
     org.opencontainers.image.authors="Sören Klein / Syndesi <[email protected]>" \
     org.opencontainers.image.licenses="GPL-3.0-only" \
     org.opencontainers.image.source="https://github.com/ember-nexus/api" \
-    org.opencontainers.image.title="Ember Nexus: API" \
-    org.opencontainers.image.description="Flexible graph based API for the modern web."
+    org.opencontainers.image.title="API" \
+    org.opencontainers.image.description="Knowledge Graph API."
 # The environment variable VERSION is set to dev by default, only release builds get their actual release version set.
 # Background: If the en user uses the dev mode, it is epected that he knows what he does.
 ARG VERSION=dev

docs/README.md

@@ -1,39 +1,51 @@
-# Ember Nexus: A Powerful API for the Modern Web
+# Ember Nexus: Knowledge Graph API
+
+Store anything, connect everything, search it all? Sure thing! 😃
 
 Ember Nexus API is a dynamic and versatile REST-API that leverages the power of graphs to provide flexible and secure
-data storage and retrieval for modern web applications.
+data storage and retrieval for data-minded people. It is open source and can be hosted on your own hardware - we
+currently support AMD and ARM architectures.
 
 ## Quick Links
 
-- [Explore the code on GitHub](https://github.com/ember-nexus/api)
+- [Getting Started](https://ember-nexus.github.io/api/#/getting-started/tech-stack)
 - [Check out the documentation](https://ember-nexus.github.io/api)
 - [Find us on Docker Hub](https://hub.docker.com/r/embernexus/api)
 
+Find us on [GitHub](https://github.com/ember-nexus/api), [our website ember-nexus.dev](https://ember-nexus.dev), and
+[Discord](https://discord.gg/3UhupSvMAa).
+
 ## Features
 
 Ember Nexus offers a range of cutting-edge features to meet your data storage needs, including:
 
-- **Graph-Based Data Model**: Ember Nexus uses an internal graph database to enable easy connections between data
-  elements, so you can build sophisticated and scalable applications.
-- **Flexible User-Defined Schemas**: With Ember Nexus, you can define your own custom schemas for your data, in
-  addition to static schemas that are built in for security reasons.
-- **UUIDs for All**: Ember Nexus assigns a UUID to every storable element, making it easy to retrieve and manage data.
-- **Near Real-Time Search**: Ember Nexus supports full-text search that is fast and responsive.
-- **Custom Graph Queries**: With Ember Nexus, you can write custom graph queries using Cypher to get the exact data
-  you need.
-- **WebDAV Support**: Ember Nexus makes it easy to use WebDAV to manage your data.
-- **Web Hooks**: Ember Nexus also supports web hooks, so you can trigger actions or events based on changes in your
-  data.
+- **Graph-based data model**: Ember Nexus uses the graph database [Neo4j](https://neo4j.com/) internally, which enables
+  you to connect any data element to any other data element and efficiently search long and recursive relations.
+- **Access through UUID**: Ember Nexus assigns a UUID to every storable element, making it easy to retrieve and manage
+  data. User can provide their own UUIDs as well, although this feature is disabled by default.
+- **Near real-time search**: Ember Nexus supports full-text search that is fast and responsive. Most of
+  [Elasticsearch](https://www.elastic.co/elasticsearch/)'s features are directly available while not bypassing the
+  security model.
+- **Secure by default**: User-created data is only visible to the owner by default. Sharing data requires explicit
+  rules, which are recursive and optionally limited in access scope and other features.
+- **High-quality software**: We invested quite a bit of time to make sure that this software is as stable as possible.
+  We employ code linters, unit tests, feature tests, memory leak tests, mutant tests, and more. Most examples in the
+  documentation are automatically checked for deprecations.
+
+## Planned Features
+
+See our [milestone](https://github.com/ember-nexus/api/milestones) and
+[issue](https://github.com/ember-nexus/api/issues) list on GitHub for planned features.
 
-## Use Cases
+## When should I use Ember Nexus API?
 
 Ember Nexus is a powerful tool for a range of use cases, including:
 
-- **Private Cloud**: Use Ember Nexus to create your own private cloud, similar to Nextcloud.
+- **Private cloud**: Use Ember Nexus to create your own private cloud, similar to Nextcloud.
 - **Websites**: Use Ember Nexus as a CMS or blog platform.
-- **Data Management Systems**: Ember Nexus is ideal for building data management systems and archives.
-- **Data Lakes**: Ember Nexus makes it easy to create data lakes, where you can store and manage large volumes of data.
-- **Interface Between Multiple Systems**: Ember Nexus can serve as a bridge between multiple systems, making it easy
-  to integrate and manage data across your entire infrastructure.
+- **Data management systems**: Ember Nexus is ideal for building data management systems and archives.
+- **Data lakes**: Ember Nexus makes it easy to create data lakes, where you can store and manage large volumes of data.
+- **Interface between multiple systems**: Ember Nexus can serve as a bridge between multiple systems, making it easy to
+  integrate and manage data across your entire infrastructure.
 
-Experience the power of Ember Nexus for yourself - [try it out today](/getting-started/tech-stack)!
+Experience the power of Ember Nexus for yourself - [try it out today](https://ember-nexus.github.io/api/#/)!