Skip to content

Commit

Permalink
Documentation update and froze deps
Browse files Browse the repository at this point in the history
  • Loading branch information
Mathieu Amiot committed Mar 6, 2018
1 parent 285ac67 commit db58bf4
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 9 deletions.
18 changes: 14 additions & 4 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ authors = ["Mathieu Amiot <[email protected]>"]
[dependencies]
serde = "1.0.27"
serde_derive = "1.0.27"
serde_json = "1.0.10"
serde_json = "1.0.9"
reqwest = "0.8.5"

[dev-dependencies]
Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# Sofa - CouchDB for Rust

## Description

This crate is an interface to CouchDB HTTP REST API. Works with stable Rust.

Does not support `#![no_std]`

After trying most crates for CouchDB in Rust (`chill`, `couchdb` in particular), none of them fit our needs hence the need to create our own.

No async I/O, uses a mix of Reqwest and Serde under the hood, with a few nice abstractions out there.

**NOT 1.0 YET, so expect changes**

**Supports CouchDB 2.0 and up.**

Be sure to check [CouchDB's Documentation](http://docs.couchdb.org/en/latest/index.html) in detail to see what's possible.

## Why the name "Sofa"?
Expand All @@ -24,4 +26,7 @@ Sofa is licensed under Apache License, Version 2.0 (http://www.apache.org/licens

## Yellow Innovation
Yellow Innovation is the innovation laboratory of the French postal service: La Poste.

We create innovative user experiences and journeys through services with a focus on IoT lately.

http://yellowinnovation.fr
12 changes: 9 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,30 +1,36 @@
//! # Sofa - CouchDB for Rust
//!
//! ## Description
//!
//! This crate is an interface to CouchDB HTTP REST API. Works with stable Rust.
//!
//! Does not support `#![no_std]`
//!
//! After trying most crates for CouchDB in Rust (`chill`, `couchdb` in particular), none of them fit our needs hence the need to create our own.
//!
//! No async I/O, uses a mix of Reqwest and Serde under the hood, with a few nice abstractions out there.
//!
//! **NOT 1.0 YET, so expect changes**
//!
//! **Supports CouchDB 2.0 and up.**
//!
//! Be sure to check [CouchDB's Documentation](http://docs.couchdb.org/en/latest/index.html) in detail to see what's possible.
//!
//!
//! ## Why the name "Sofa"?
//! CouchDB has a nice name, and I wanted to reflect that.
//!
//! ## Documentation
//! Here: http://docs.rs/sofa

//!
//! ## License
//! Sofa is licensed under Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)

//!
//! ## Yellow Innovation
//! Yellow Innovation is the innovation laboratory of the French postal service: La Poste.
//!
//! We create innovative user experiences and journeys through services with a focus on IoT lately.
//!
//! http://yellowinnovation.fr

extern crate reqwest;
extern crate serde;
Expand Down

0 comments on commit db58bf4

Please sign in to comment.