Add proper documentation

README.md

@@ -1,119 +1,9 @@
-evalexpr
+# evalexpr
-========
-
-**This is a fork of the eval crate originally created by fengcen and then abandoned.**
-
-<!-- [![Project Status: Abandoned – Initial development has started, but there has not yet been a stable, usable release; the project has been abandoned and the author(s) do not intend on continuing development.](https://www.repostatus.org/badges/latest/abandoned.svg)](https://www.repostatus.org/#abandoned) -->
 
 [![docs](https://docs.rs/evalexpr/badge.svg?version=0.4.4 "docs")](https://docs.rs/evalexpr)
 
-Evalexpr is a powerful expression evaluator.
+Evalexpr is a powerful arithmetic and boolean expression evaluator.
 
-[Document](https://docs.rs/evalexpr)
+## [Documentation](https://docs.rs/evalexpr)
---------------------------------
 
-Features
+<!-- cargo-sync-readme -->
---------
-
-Supported operators: `!` `!=` `""` `''` `()` `[]` `,` `>` `<` `>=` `<=` `==`
-`+` unary/binary `-` `*` `/` `%` `&&` `||` `n..m`.
-
-Built-in functions: `min()` `max()` `len()` `is_empty()` `array()` `converge()`.
-See the `builtin` module for a detailed description of each.
-
-Where can eval be used?
------------------------
-
-* Template engine
-* Scripting language
-* ...
-
-Usage
------
-
-Add dependency to Cargo.toml
-
-```toml
-[dependencies]
-evalexpr = "0.4"
-```
-
-In your `main.rs` or `lib.rs`:
-
-```rust
-extern crate evalexpr as eval;
-```
-
-Examples
---------
-
-You can do mathematical calculations with supported operators:
-
-```rust
-use eval::{eval, to_value};
-
-assert_eq!(eval("1 + 2 + 3"), Ok(to_value(6)));
-assert_eq!(eval("2 * 2 + 3"), Ok(to_value(7)));
-assert_eq!(eval("2 / 2 + 3"), Ok(to_value(4.0)));
-assert_eq!(eval("2 / 2 + 3 / 3"), Ok(to_value(2.0)));
-```
-
-You can eval with context:
-
-```rust
-use eval::{Expr, to_value};
-
-assert_eq!(Expr::new("foo == bar")
-               .value("foo", true)
-               .value("bar", true)
-               .exec(),
-           Ok(to_value(true)));
-```
-
-You can access data like javascript by using `.` and `[]`. `[]` supports expression.
-
-```rust
-use eval::{Expr, to_value};
-use std::collections::HashMap;
-
-let mut object = HashMap::new();
-object.insert("foos", vec!["Hello", "world", "!"]);
-
-assert_eq!(Expr::new("object.foos[1-1] == 'Hello'")
-               .value("object", object)
-               .exec(),
-           Ok(to_value(true)));
-```
-
-You can eval with function:
-
-```rust
-use eval::{Expr, to_value};
-
-assert_eq!(Expr::new("say_hello()")
-               .function("say_hello", |_| Ok(to_value("Hello world!")))
-               .exec(),
-           Ok(to_value("Hello world!")));
-```
-
-You can create an array with `array()`:
-
-```rust
-use eval::{eval, to_value};
-
-assert_eq!(eval("array(1, 2, 3, 4, 5)"), Ok(to_value(vec![1, 2, 3, 4, 5])));
-```
-
-You can create an integer array with `n..m`:
-
-```rust
-use eval::{eval, to_value};
-
-assert_eq!(eval("0..5"), Ok(to_value(vec![0, 1, 2, 3, 4])));
-```
-
-License
--------
-
-evalexpr is primarily distributed under the terms of the MIT license.
-See [LICENSE](LICENSE) for details.

src/lib.rs

@@ -1,3 +1,116 @@
+//!
+//! ## Features
+//!
+//! Supported binary operators:
+//!
+//! | + | - | * | % | < | > | <= | >= | == | && | || |
+//! 
+//!Supported binary operators: `!` `!=` `""` `''` `()` `[]` `,` `>` `<` `>=` `<=` `==`
+//!`+` unary/binary `-` `*` `/` `%` `&&` `||` `n..m`.
+//!
+//!Supported unary operators: ``
+//!
+//!Built-in functions: `min()` `max()` `len()` `is_empty()` `array()` `converge()`.
+//!See the `builtin` module for a detailed description of each.
+//!
+//!Where can eval be used?
+//!-----------------------
+//!
+//!* Template engine
+//!* Scripting language
+//!* ...
+//!
+//!Usage
+//!-----
+//!
+//!Add dependency to Cargo.toml
+//!
+//!```toml
+//![dependencies]
+//!evalexpr = "0.4"
+//!```
+//!
+//!In your `main.rs` or `lib.rs`:
+//!
+//!```rust
+//!extern crate evalexpr as eval;
+//!```
+//!
+//!Examples
+//!--------
+//!
+//!You can do mathematical calculations with supported operators:
+//!
+//!```rust
+//!use eval::{eval, to_value};
+//!
+//!assert_eq!(eval("1 + 2 + 3"), Ok(to_value(6)));
+//!assert_eq!(eval("2 * 2 + 3"), Ok(to_value(7)));
+//!assert_eq!(eval("2 / 2 + 3"), Ok(to_value(4.0)));
+//!assert_eq!(eval("2 / 2 + 3 / 3"), Ok(to_value(2.0)));
+//!```
+//!
+//!You can eval with context:
+//!
+//!```rust
+//!use eval::{Expr, to_value};
+//!
+//!assert_eq!(Expr::new("foo == bar")
+//!               .value("foo", true)
+//!               .value("bar", true)
+//!               .exec(),
+//!           Ok(to_value(true)));
+//!```
+//!
+//!You can access data like javascript by using `.` and `[]`. `[]` supports expression.
+//!
+//!```rust
+//!use eval::{Expr, to_value};
+//!use std::collections::HashMap;
+//!
+//!let mut object = HashMap::new();
+//!object.insert("foos", vec!["Hello", "world", "!"]);
+//!
+//!assert_eq!(Expr::new("object.foos[1-1] == 'Hello'")
+//!               .value("object", object)
+//!               .exec(),
+//!           Ok(to_value(true)));
+//!```
+//!
+//!You can eval with function:
+//!
+//!```rust
+//!use eval::{Expr, to_value};
+//!
+//!assert_eq!(Expr::new("say_hello()")
+//!               .function("say_hello", |_| Ok(to_value("Hello world!")))
+//!               .exec(),
+//!           Ok(to_value("Hello world!")));
+//!```
+//!
+//!You can create an array with `array()`:
+//!
+//!```rust
+//!use eval::{eval, to_value};
+//!
+//!assert_eq!(eval("array(1, 2, 3, 4, 5)"), Ok(to_value(vec![1, 2, 3, 4, 5])));
+//!```
+//!
+//!You can create an integer array with `n..m`:
+//!
+//!```rust
+//!use eval::{eval, to_value};
+//!
+//!assert_eq!(eval("0..5"), Ok(to_value(vec![0, 1, 2, 3, 4])));
+//!```
+//!
+//!License
+//!-------
+//!
+//!evalexpr is primarily distributed under the terms of the MIT license.
+//!See [LICENSE](LICENSE) for details. 
+//!
+
 mod configuration;
 mod error;
 mod function;