Skip to content

Commit

Permalink
Merge pull request #23 from ember-nexus/chore/update-readme
Browse files Browse the repository at this point in the history
Update readme.
  • Loading branch information
Syndesi authored Oct 28, 2023
2 parents caf005f + de74489 commit 1a1b268
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 1a1b268

Please sign in to comment.