From de74489108d8b3b76aa7f77f01fe0a457fa90a2f Mon Sep 17 00:00:00 2001 From: Syndesi Date: Sat, 28 Oct 2023 17:29:37 +0200 Subject: [PATCH] Update readme. --- CHANGELOG.md | 2 ++ README.md | 23 ++++++++++++++++++++--- 2 files changed, 22 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6782948..eac9abd 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,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. ## 0.0.13 - 2023-10-06 ### Changed diff --git a/README.md b/README.md index 87114ef..cf0942b 100755 --- a/README.md +++ b/README.md @@ -1,4 +1,21 @@ -# Ember Nexus Reference Dataset +# Ember Nexus: Reference Dataset -This repository is an Ember Nexus backup containing different situations, scenarios and graph structures. -It is used in other Ember Nexus projects for their feature tests. +Ember Nexus' reference dataset is a standardized API backup containing different situations, scenarios and graph structures. +It is used within other Ember Nexus projects' feature tests. + +## Quick Links + +Find us on [GitHub](https://github.com/ember-nexus/reference-dataset), +[our website ember-nexus.dev](https://ember-nexus.dev), and [Discord](https://discord.gg/3UhupSvMAa). + +## Features + +- API endpoints: Scenarios to test all REST endpoints from Ember Nexus API. +- Frontend: A single scenario that contains data that might be displayed in actual frontends. +- General: Scenarios regarding specific features spanning multiple API endpoints. +- Security: Scenarios explicitly created to test and verify Ember Nexus API's security model. + +## Planned Features + +See our [milestone](https://github.com/ember-nexus/reference-dataset/milestones) and +[issue](https://github.com/ember-nexus/reference-dataset/issues) list on GitHub for planned features.