Skip to content

Commit

Permalink
Updated readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
f3ath committed Mar 21, 2019
1 parent b7dd991 commit b77d74d
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 23 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]

## [0.5.0] - 2019-03-21
### Changed
- More BC-breaking changes in the Server

Expand Down Expand Up @@ -45,7 +47,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added
- Client: fetch resources, collections, related resources and relationships

[Unreleased]: https://github.com/f3ath/json-api-dart/compare/0.4.0...HEAD
[Unreleased]: https://github.com/f3ath/json-api-dart/compare/0.5.0...HEAD
[0.5.0]: https://github.com/f3ath/json-api-dart/compare/0.4.0...0.5.0
[0.4.0]: https://github.com/f3ath/json-api-dart/compare/0.3.0...0.4.0
[0.3.0]: https://github.com/f3ath/json-api-dart/compare/0.2.0...0.3.0
[0.2.0]: https://github.com/f3ath/json-api-dart/compare/0.1.0...0.2.0
35 changes: 14 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,20 @@ a Client (VM, Flutter, Web), and a Server (VM only).


## Supported features
- [x] Fetching single resources and resource collections
- [x] Collection pagination
- [x] Fetching relationships and related resources and collections
- [x] Fetching single resources
- [x] Creating resources
- [x] Deleting resources
- [x] Updating resource's attributes
- [x] Updating resource's relationships
- [x] Updating relationships
- [x] Compound documents
- [x] Related collection pagination
- [x] Asynchronous processing

- [ ] Support `meta` members
- [ ] Support `jsonapi` members
- [ ] Structural Validation including compound documents and sparse fieldsets
- [ ] Naming Validation
- [ ] Meaningful parsing exceptions
- [ ] JSON:API v1.1 features

### Usage
- Fetching single resources and resource collections
- Collection pagination
- Fetching relationships and related resources and collections
- Fetching single resources
- Creating resources
- Deleting resources
- Updating resource's attributes
- Updating resource's relationships
- Updating relationships
- Compound documents
- Related collection pagination
- Asynchronous processing

## Usage
In the VM:
```dart
import 'package:json_api/client.dart';
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ author: "Alexey Karapetov <[email protected]>"
description: "JSON:API v1.0 (http://jsonapi.org) Document, Client, and Server"
homepage: "https://github.com/f3ath/json-api-dart"
name: "json_api"
version: "0.4.0"
version: "0.5.0"
dependencies:
collection: "^1.14.11"
http: "^0.12.0"
Expand Down

0 comments on commit b77d74d

Please sign in to comment.