Skip to content

Commit 059c655

Browse files
committed
fix: Reorganize README and remove separate readme for reference docs
1 parent 3acfe46 commit 059c655

File tree

2 files changed

+18
-96
lines changed

2 files changed

+18
-96
lines changed

README.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# contentful.js
2-
31
[![npm](https://img.shields.io/npm/v/contentful.svg)](https://www.npmjs.com/package/contentful)
42
[![Build Status](https://travis-ci.org/contentful/contentful.js.svg?branch=master)](https://travis-ci.org/contentful/contentful.js)
53
[![Coverage Status](https://coveralls.io/repos/github/contentful/contentful.js/badge.svg?branch=master)](https://coveralls.io/github/contentful/contentful.js?branch=master)
@@ -91,12 +89,25 @@ You can try and change the above example at [Tonic](https://tonicdev.com/npm/con
9189

9290
## Documentation/References
9391

94-
In order to do more with this SDK, have a look at the various documentation links below:
92+
To help you get the most out of this SDK, we've prepared reference documentation, tutorials and other examples that will help you learn and understand how to use this library.
93+
94+
### Reference documentation
95+
96+
The [Contentful's JS SDK reference](https://contentful.github.io/contentful.js) documents what objects and methods are exposed by this library, what arguments they expect and what kind of data is returned.
97+
98+
Most methods also have examples which show you how to use them.
99+
100+
You can start by looking at the top level [`contentful`](./contentful.html) namespace.
101+
102+
From version 3.0.0 onwards, you can access documentation for a specific version by visiting `https://contentful.github.io/contentful.js/contentful/<VERSION>`
103+
104+
### Contentful JavaScript resources
105+
106+
Check the [Contentful for JavaScript](https://www.contentful.com/developers/docs/javascript/) page for Tutorials, Demo Apps, and more information on other ways of using JavaScript with Contentful
107+
108+
### REST API reference
95109

96-
* [Contentful's JS SDK reference](https://contentful.github.io/contentful.js)
97-
* From version 3.0.0 onwards, you can access documentation for a specific version by visiting `https://contentful.github.io/contentful.js/contentful/<VERSION>`
98-
* Check the [Contentful for JavaScript](https://www.contentful.com/developers/docs/javascript/) page for Tutorials, Demo Apps, and more information on other ways of using JavaScript with Contentful
99-
* [Contentful's CDA REST API reference](https://www.contentful.com/developers/docs/references/content-delivery-api/) for additional details on the Delivery API
110+
This library is a wrapper around our Contentful Delivery REST API. Some more specific details such as search parameters and pagination are better explained on the [REST API reference](https://www.contentful.com/developers/docs/references/content-delivery-api/), and you can also get a better understanding of how the requests look under the hood.
100111

101112
### Legacy contentful.js
102113

reference_docs_index.md

Lines changed: 0 additions & 89 deletions
This file was deleted.

0 commit comments

Comments
 (0)