Skip to content

Commit

Permalink
feat: remove external_doc feature
Browse files Browse the repository at this point in the history
  • Loading branch information
fMeow committed Apr 11, 2019
1 parent 43e297c commit f5ad703
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
#![feature(external_doc)]
#![doc(include = "../README.md")]
//! An ergonomic [arangoDB](https://www.arangodb.com/) client for rust.
//! `arangors` enables you to connect with arangoDB server, access to database,
//! execute AQL query, manage arangoDB in an easy and intuitive way.
//!
//! ## Philosophy of arangors
//!
//! `arangors` is targeted at ergonomic, intuitive and OOP-like API for
//! ArangoDB, both top level and low level API for users' choice.
//!
//! Overall architecture of arangoDB:
//!
//! > databases -> collections -> documents/edges
//!
//! In fact, the design of `arangors` just mimic this architecture, with a
//! slight difference that in the top level, there is a connection object on top
//! of databases, containing a HTTP client with authentication information in
//! HTTP headers.
//!
//! Hierarchy of arangors:
//! > connection -> databases(cached) -> collections -> documents/edges
pub mod aql;
pub mod collection;
Expand Down

0 comments on commit f5ad703

Please sign in to comment.