From f5ad703af7153331ea73d4937fe70658325ede13 Mon Sep 17 00:00:00 2001 From: Guoli Lyu Date: Sun, 3 Feb 2019 21:36:34 +0800 Subject: [PATCH] feat: remove external_doc feature --- src/lib.rs | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index f349c72..95bec9e 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -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;