Skip to content

Commit

Permalink
Merge pull request #78 from strongloop/update-readme
Browse files Browse the repository at this point in the history
docs: update readme
  • Loading branch information
agnes512 authored Jul 28, 2020
2 parents 71717e8 + b8a440e commit d269606
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 37 deletions.
4 changes: 2 additions & 2 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# the last matching pattern has the most precedence.

# Alumni maintainers
# @ssh24 @virkt25 @loay @kjdelisle
# @ssh24 @virkt25 @loay @kjdelisle @b-admike

# Core team members from IBM
* @jannyHou @b-admike @dhmlau
* @jannyHou @dhmlau
53 changes: 18 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,25 @@
# loopback-connector-couchdb2

The `loopback-connector-couchdb2` module is the CouchDB 2.0 connector for the
The `loopback-connector-couchdb2` module is the CouchDB 2.x connector for the
LoopBack framework that supports the advanced functionality originally found
only in Cloudant but that is now available in CouchDB.

<!-- TOC -->

- [Getting Started](#getting-started)
- [Model](#model)
- [Map Between Model And Document](#map-between-model-and-document)
- [Model-specific Configuration](#model-specific-configuration)
- [_rev Property](#_rev-property)
- [Example CRUD operations with `_rev`](#example-crud-operations-with-_rev)
- [Setup Couchdb Instance](#setup-couchdb-instance)
- [Installation](#installation)
- [Configuration](#configuration)
- [Generate Datasource](#generate-datasource)
- [Datasource Config](#datasource-config)
- [Example Usage](#example-usage)
- [CRUD](#crud)
- [Migration](#migration)
- [autoupdate vs automigrate](#autoupdate-vs-automigrate)
- [isActual](#isactual)
- [property index](#property-index)
- [Example Code](#example-code)
- [Discovery](#discovery)
- [Query](#query)
- [View](#view)
- [Bulk replace](#bulk-replace)
- [Testing](#testing)
- [Docker](#docker)
- [More into](#more-info)

<!-- /TOC -->

# Getting Started

## Model
## Installation

In your application root directory, enter this command to install the connector:

```sh
npm install loopback-connector-couchdb2 --save
```

This installs the module from npm and adds it as a dependency to the
application's `package.json` file.

If you create a CouchDB 2.x data source using the data source generator as described
below, you don't have to do this, since the generator will run `npm install` for
you.

## Getting Started - Model

### Map Between Model And Document

Expand Down Expand Up @@ -226,7 +209,7 @@ Let's say we have an instance in the database:

For users that don't have a Couchdb server to develop or test, here are some suggestions can help you quickly set one up.
For development use, a docker container is easy to setup. Users can also download the on-prem Couchdb2.0 from http://couchdb.apache.org/
For development use, a docker container is easy to setup. Users can also download the on-prem Couchdb 2.x from http://couchdb.apache.org/
# Installation
Expand Down

0 comments on commit d269606

Please sign in to comment.