Skip to content

Commit 015938f

Browse files
authoredApr 28, 2018
Merge pull request #272 from json-api-dotnet/docs/readme
Improve README.md
2 parents 08e2945 + 9f517bf commit 015938f

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed
 

‎README.md

+10
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@
1212

1313
A framework for building [json:api](http://jsonapi.org/) compliant web APIs. The ultimate goal of this library is to eliminate as much boilerplate as possible by offering out-of-the-box features such as sorting, filtering and pagination. You just need to focus on defining the resources and implementing your custom business logic. This library has been designed around dependency injection making extensibility incredibly easy.
1414

15+
## Getting Started
16+
17+
These are some steps you can take to help you understand what this project is and how you can use it:
18+
19+
- [What is json:api and why should I use it?](https://nordicapis.com/the-benefits-of-using-json-api/)
20+
- [The json:api specification](http://jsonapi.org/format/)
21+
- [Demo [Video]](https://youtu.be/KAMuo6K7VcE)
22+
- [Our documentation](https://json-api-dotnet.github.io)
23+
- Check out the examples in the next section
24+
1525
## Examples
1626

1727
See the [examples](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/src/Examples) directory for up-to-date sample applications. There is also a [Todo List App](https://github.com/json-api-dotnet/TodoListExample) that includes a JADNC API and an EmberJs client.

0 commit comments

Comments
 (0)
Please sign in to comment.