Skip to content

Commit de64d40

Browse files
committed
Updated README.md
1 parent 0c943f4 commit de64d40

File tree

1 file changed

+6
-30
lines changed

1 file changed

+6
-30
lines changed

README.md

Lines changed: 6 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,27 @@
1-
# fauxton-client
1+
# fauxton
22

33
[![Build Status](https://travis-ci.org/ace411/fauxton-client.svg?branch=async)](https://travis-ci.org/ace411/fauxton-client)
44
[![codecov](https://codecov.io/gh/ace411/fauxton-client/branch/async/graph/badge.svg)](https://codecov.io/gh/ace411/fauxton-client)
55

6-
A simple CouchDB interaction library.
7-
8-
**Note:** This version of the fauxton-client is dependent on ReactPHP. As such, it offers the cogencies of CouchDB interactions in a non-blocking IO environment.
6+
Async version of the [fauxton-client](https://github.com/ace411/fauxton-client) powered by [ReactPHP](https://reactphp.org). As such, it offers the cogencies of CouchDB interactions in a non-blocking IO environment.
97

108
## Requirements
119

1210
- PHP 7.1+
1311

1412
## Installation
1513

16-
fauxton-client is available on Packagist. To install it, type the following on your preferred
14+
The fauxton library is available on Packagist. To install it, type the following on your preferred
1715
command-line interface:
1816

1917
```
20-
composer require php-api-clients/fauxton-client
18+
composer require php-api-clients/fauxton
2119
```
2220

23-
## Fauxton
24-
25-
Fauxton, formerly Futon, is the name of the Couch Database web client. Like its predecessor, Fauxton
26-
is a robust web interface designed to ease interactions with CouchDB.
27-
28-
## The client
29-
30-
Fauxton-client is a PHP library written for the sole purpose of performing CouchDB operations such as
31-
creating databases, creating indexes and writing Mango queries.
32-
33-
34-
## NoSQL vs SQL
35-
36-
Structured Query Language (SQL) is a popular approach to handling back-end information and follows
37-
Atomicity Consistency Isolation and Durability (ACID) conventions. Simply put, SQL databases allow
38-
those who use them to store unique data in relational, table structures.
39-
40-
NoSQL, on the other hand, presents a different paradigm to handling data interactions:
41-
NoSQL standards are a manifestation of Basically Available Soft-state Eventually consistent (BASE) practices.
42-
Couch Database is a NoSQL database that follows a document-oriented, key-value pair format
43-
that is also convenient for manipulating data.
44-
4521
## Documentation
4622

47-
I advise that you read the [official CouchDB documentation](http://docs.couchdb.org/en/2.0.0/api/index.html)
48-
so as to better understand the fauxton-client. Also, check out the examples in the [examples folder](https://github.com/php-api-clients/fauxton-client/tree/master/examples) for more perspective.
23+
I advise that you read the [official CouchDB documentation](http://docs.couchdb.org)
24+
so as to better understand fauxton. Also, check out the examples in the [examples folder](https://github.com/php-api-clients/fauxton-client/tree/master/examples) for more perspective.
4925

5026
## Running the unit tests
5127

0 commit comments

Comments
 (0)