Skip to content

Commit

Permalink
Documentation and README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mbrubeck committed Jul 24, 2015
1 parent f651d17 commit 6993083
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ authors = ["The Servo Project Developers"]
license = "MIT / Apache-2.0"
description = "Implementation of the Unicode Bidirectional Algorithm"
repository = "https://github.com/servo/unicode-bidi"
documentation = "http://doc.servo.org/unicode_bidi/"
keywords = ["rtl", "unicode", "text", "layout", "bidi"]

[lib]
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

This crate implements the [Unicode Bidirectional Algorithm][tr9] for display
of mixed right-to-left and left-to-right text. It is written in safe Rust,
compatible with Rust 1.0 and later.
compatible with the current stable release.

[Documentation](http://doc.servo.org/unicode_bidi/)

[![Build Status](https://travis-ci.org/servo/unicode-bidi.svg?branch=master)](https://travis-ci.org/servo/unicode-bidi)

[tr9]: http://www.unicode.org/reports/tr9/
6 changes: 3 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
// except according to those terms.

//! This crate implements the [Unicode Bidirectional Algorithm][tr9] for display of mixed
//! right-to-left and left-to-right text. It is written in safe Rust, compatible with Rust 1.0 and
//! later.
//! right-to-left and left-to-right text. It is written in safe Rust, compatible with the
//! current stable release.
//!
//! ## Example
//!
Expand Down Expand Up @@ -150,7 +150,7 @@ fn class_for_level(level: u8) -> BidiClass {

/// Re-order a line based on resolved levels.
///
/// `info` is the result of calling `process_text` on `text`.
/// `levels` are the embedding levels returned by `process_text`.
/// `line` is a range of bytes indices within `text`.
///
/// Returns the line in display order.
Expand Down

0 comments on commit 6993083

Please sign in to comment.