docs: 📝 Add README & Doc & LICENSE

Author: KAIYOHUGO

Cargo.toml

@@ -1,7 +1,14 @@
 [package]
-name = "sstt"
+name = "SSTT"
 version = "0.1.0"
 edition = "2021"
+authors = ["Kaiyo Hugo"]
+keywords = ["syn", "traits","trait", "utility"]
+categories = ["category:development-tools::procedural-macro-helpers"]
+license = "MIT"
+description = "More Syn Syntax Tree Traversal Trait"
+repository = "https://github.com/MadyLab/SSTT"
+
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,41 @@
+<center>
+
+# SSTT
+
+More **S**yn **S**yntax **T**ree **T**raversal Trait
+
+![GitHub](https://img.shields.io/github/license/madylab/sstt?style=for-the-badge) ![Crates.io](https://img.shields.io/crates/v/sstt?style=for-the-badge) ![docs.rs](https://img.shields.io/docsrs/sstt?style=for-the-badge)
+
+SSTT crate provide some useful trait for syn syntax tree traversal.
+</center>
+
+## Example
+
+fallible [Fold](https://docs.rs/syn/latest/syn/fold/index.html)
+
+```rust
+pub trait TryFold {
+    type Error;
+
+    fn try_fold_abi(&mut self, t: syn::Abi) -> Result<syn::Abi, Self::Error>
+    {
+        try_fold_abi(self, t)
+    }
+
+    // ...
+}
+```
+
+fallible take (like fold but without return new value)
+
+```rust
+pub trait TryTake {
+    type Error;
+
+    fn try_take_abi(&mut self, t: syn::Abi) -> Result<(), Self::Error> {
+        try_take_abi(self, t)
+    }
+
+    // ...
+}
+```

src/lib.rs

@@ -1,2 +1,4 @@
+#![doc = include_str!("../README.md")]
+
 pub mod try_fold;
 pub mod try_take;