Skip to content

Commit eab8cf9

Browse files
committed
Improve documentation, README.md
1 parent 8946422 commit eab8cf9

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
[![crates.io](https://img.shields.io/crates/v/sonyflake.svg)](https://crates.io/crates/sonyflake)
66
[![docs.rs](https://docs.rs/sonyflake/badge.svg)](https://docs.rs/sonyflake/)
77

8+
A distributed unique ID generator inspired by [Twitter's Snowflake](https://blog.twitter.com/2010/announcing-snowflake).
89

9-
10-
A Rust implementation of [Sonyflake](https://github.com/sony/sonyflake), a distributed unique ID generator inspired by [Twitter's Snowflake](https://blog.twitter.com/2010/announcing-snowflake).
10+
This is a Rust implementation of the original [sony/sonyflake](https://github.com/sony/sonyflake), which is written in Go.
1111

1212
## Install
1313

src/lib.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
//! Sonyflake is a Rust implementation of the [Sonyflake] algorithm.
1+
//! A distributed unique ID generator inspired by [Twitter's Snowflake].
2+
//!
3+
//! This is a Rust implementation of the original [sony/sonyflake], which is written in Go.
24
//!
35
//! ## Quickstart
46
//!
@@ -40,7 +42,8 @@
4042
//! }
4143
//! ```
4244
//!
43-
//! [Sonyflake]: https://github.com/sony/sonyflake
45+
//! [sony/sonyflake]: https://github.com/sony/sonyflake
46+
//! [Twitter's Snowflake]: https://blog.twitter.com/2010/announcing-snowflake
4447
4548
mod builder;
4649
mod error;

0 commit comments

Comments
 (0)