From 059c655621ebe9911da21bc151f7d48b6f4c7835 Mon Sep 17 00:00:00 2001 From: Tiago Rodrigues Date: Mon, 30 May 2016 13:52:38 +0200 Subject: [PATCH] fix: Reorganize README and remove separate readme for reference docs --- README.md | 25 ++++++++---- reference_docs_index.md | 89 ----------------------------------------- 2 files changed, 18 insertions(+), 96 deletions(-) delete mode 100644 reference_docs_index.md diff --git a/README.md b/README.md index 8ebfc87e0..4b5dc3678 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -# contentful.js - [![npm](https://img.shields.io/npm/v/contentful.svg)](https://www.npmjs.com/package/contentful) [![Build Status](https://travis-ci.org/contentful/contentful.js.svg?branch=master)](https://travis-ci.org/contentful/contentful.js) [![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 ## Documentation/References -In order to do more with this SDK, have a look at the various documentation links below: +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. + +### Reference documentation + +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. + +Most methods also have examples which show you how to use them. + +You can start by looking at the top level [`contentful`](./contentful.html) namespace. + + From version 3.0.0 onwards, you can access documentation for a specific version by visiting `https://contentful.github.io/contentful.js/contentful/` + +### Contentful JavaScript resources + +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 + +### REST API reference -* [Contentful's JS SDK reference](https://contentful.github.io/contentful.js) - * From version 3.0.0 onwards, you can access documentation for a specific version by visiting `https://contentful.github.io/contentful.js/contentful/` -* 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 -* [Contentful's CDA REST API reference](https://www.contentful.com/developers/docs/references/content-delivery-api/) for additional details on the Delivery API +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. ### Legacy contentful.js diff --git a/reference_docs_index.md b/reference_docs_index.md deleted file mode 100644 index 722f31f07..000000000 --- a/reference_docs_index.md +++ /dev/null @@ -1,89 +0,0 @@ -Javascript SDK for [Contentful's](https://www.contentful.com) Content Delivery API. - -## About - -[Contentful](https://www.contentful.com) is a content management platform for web applications, mobile apps and connected devices. It allows you to create, edit & manage content in the cloud and publish it anywhere via a powerful API. Contentful offers tools for managing editorial teams and enabling cooperation between organizations. - -## Features - -- Content retrieval through Contentful's [Content Delivery API](https://www.contentful.com/developers/docs/references/content-delivery-api/). -- [Synchronization](https://www.contentful.com/developers/docs/concepts/sync/) -- [Localization support](https://www.contentful.com/developers/docs/concepts/locales/) -- [Link resolution](https://www.contentful.com/developers/docs/concepts/links/) - -## Supported environments - -Browsers and Node.js: -- Chrome -- Firefox -- IE11 / Edge -- node.js >= 0.10 - -## Getting started - -In order to get started with the Contentful JS SDK you'll need not only to install it, but also to get credentials which will allow you to have access to your content in Contentful. - -## Installation - -In node, using [npm](http://npmjs.org): - -``` sh -npm install contentful -``` - -Or, if you'd like to use a standalone built file you can use the following script tag or just download it from [npmcdn](https://npmcdn.com), under the `browser-dist` directory: - -``` html - -``` - -Using `contentful@latest` will always get you the latest version, but you can also specify a specific version number: - -``` html - -``` - -## Authentication - -To get content from Contentful, an app should authenticate with an with an OAuth bearer token. - -You can create API keys using [Contentful's web interface](https://app.contentful.com). Go to the app, open the space that you want to access (top left corner lists all the spaces), and navigate to the APIs area. Open the API Keys section and create your first token. Done. - -Don't forget to also get your Space ID. - -For more information, check the Contentful's REST API reference on [Authentication](https://www.contentful.com/developers/docs/references/authentication/). - -## Documentation/References - -The first thing you want to look at is the [`contentful`](./contentful.html) namespace. - -Here's a quick description of the other namespaces: -* [`ContentfulClientAPI`](./ContentfulClientAPI.html) - The main client object, which provides the methods to get entities out of Contentful such as Entries, Assets and Content Types. -* [`Entities`](./Entities.html) - Defines properties and methods for each of the different entities you'll find in Contentful. -* [`EntryFields`](./EntryFields.html) - Defines the different kinds of fields you will find in Entries. -* [`Sync`](./Sync.html) - Defines the types used when working with the [Synchronization](https://www.contentful.com/developers/docs/concepts/sync/) endpoint - -Additional resources: -* 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 -* [Contentful's CDA REST API reference](https://www.contentful.com/developers/docs/references/content-delivery-api/) for additional details on the Delivery API - - -## Versioning - -This project strictly follows [Semantic Versioning](http://semver.org/) by use of [semantic-release](https://github.com/semantic-release/semantic-release). - -This means that new versions are released automatically as fixes, features or breaking changes are released. - -You can check the changelog on the [releases](https://github.com/contentful/contentful.js/releases) page. - -## Support - -Please open an [issue](https://github.com/contentful/contentful.js/issues/new) - -## Contributing - -See [CONTRIBUTING.md](https://github.com/contentful/contentful.js/blob/master/CONTRIBUTING.md) - -## License - -MIT