Add readme

This commit is contained in:
David Tolnay 2022-05-16 14:29:11 -07:00
parent 1842f6fe4f
commit 5986ec0047
No known key found for this signature in database
GPG Key ID: F9BA143B95FF6D82

27
README.md Normal file
View File

@ -0,0 +1,27 @@
Unicode ident
=============
Implementation of [Unicode Standard Annex #31][tr31] for determining which
`char` values are valid in programming language identifiers.
[tr31]: https://www.unicode.org/reports/tr31/
This crate is a better optimized implementation of the older `unicode-xid`
crate. This crate uses less static storage, and is able to classify both ASCII
and non-ASCII codepoints with better performance, 2–10× faster than
`unicode-xid`.
## License
<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>
<br>
<sub>
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.
</sub>