Merge pull request #8 from kitsuyui/update-cargo-package-info

Update cargo package info

Cargo.toml

@@ -1,6 +1,9 @@
 [package]
 name = "bittersweet"
 version = "0.1.0"
+authors = ["Yui Kitsu <kitsuyui+github@kitsuyui.com>"]
+description = "Add more intentional predicates to bitwise calcs."
+license = "BSD-3-Clause"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

LICENSE

@@ -0,0 +1,11 @@
+Copyright 2022 Kitsu Yui
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,29 @@
+# bittersweet
+
+![Crates.io](https://img.shields.io/crates/v/bittersweet)
+[![codecov](https://codecov.io/gh/kitsuyui/bittersweet/branch/main/graph/badge.svg?token=G5SJOXT99J)](https://codecov.io/gh/kitsuyui/bittersweet)
+[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+
+
+Currently under development.
+
+## Documentation
+
+Check out [doc.rs](https://docs.rs/bittersweet/latest/bittersweet/)
+
+## Usage
+
+```rust
+mod bitline;
+use crate::bitline::Bitline;
+fn main() {
+    let t = 0b00111000_u8 as bitline::Bitline8;
+    if t.includes(0b00110000_u8) {
+        println!("Yes!");
+    }
+}
+```
+
+## License
+
+BSD-3-Clause