📃 docs: README.md

vhidvz · Sep 6, 2023 · 5b2adce · 5b2adce
1 parent ad367cf
commit 5b2adce
Show file tree

Hide file tree

Showing 16 changed files with 66 additions and 55 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -3,7 +3,7 @@ name = "naming-conventions"
 description = "Naming Conventions"
 
 edition = "2021"
-version = "1.0.0"
+version = "1.0.1"
 rust-version = "1.68"
 
 authors = ["Vahid V. <[email protected]>"]

diff --git a/README.md b/README.md
@@ -21,8 +21,19 @@ fn main() {
 
   let string = "camelCase";
 
-  println!("string to snake_case: {}", snake_case.to(string).unwrap());
-  println!("string is snake_case: {}", snake_case.is(string).unwrap());
+  println!("to snake_case: {}", snake_case.to(string).unwrap());
+  println!("is snake_case: {}", snake_case.is(string).unwrap());
+}
+```
+
+```rust
+use naming_conventions::{to_snake_case, is_snake_case};
+
+fn main() {
+  let string = "camelCase";
+
+  println!("to snake_case: {}", to_snake_case(string).unwrap());
+  println!("is snake_case: {}", is_snake_case(string).unwrap());
 }
 ```
 

diff --git a/docs/coverage/html/index.html b/docs/coverage/html/index.html
@@ -23,7 +23,7 @@
         <div>
             <p class="heading">Functions</p>
             <p class="title has-text-danger">
-                <abbr title="74 / 158">46.84 %</abbr></p>
+                <abbr title="74 / 247">29.96 %</abbr></p>
         </div>
     </div>
 
@@ -69,8 +69,8 @@
             51 / 58
         </td>
         <!-- -->
-        <td class="has-text-centered has-background-danger p-2">59.09%</td>
-        <td class="has-text-centered has-background-danger p-2">13 / 22 </td>
+        <td class="has-text-centered has-background-danger p-2">37.14%</td>
+        <td class="has-text-centered has-background-danger p-2">13 / 35 </td>
         <!-- -->
 
             <td class="has-text-centered has-background-success p-2">100%</td>
@@ -96,8 +96,8 @@
             305 / 454
         </td>
         <!-- -->
-        <td class="has-text-centered has-background-danger p-2">44.85%</td>
-        <td class="has-text-centered has-background-danger p-2">61 / 136 </td>
+        <td class="has-text-centered has-background-danger p-2">28.77%</td>
+        <td class="has-text-centered has-background-danger p-2">61 / 212 </td>
         <!-- -->
 
             <td class="has-text-centered has-background-success p-2">100%</td>
@@ -108,7 +108,7 @@
     </table></div>
         <footer class="footer">
             <div class="content has-text-centered">
-                <p class="heading">Date: 2023-09-06 16:49</p>
+                <p class="heading">Date: 2023-09-06 17:05</p>
             </div>
         </footer>
     </body>

diff --git a/docs/coverage/html/src/conventions/camel_case.rs.html b/docs/coverage/html/src/conventions/camel_case.rs.html
@@ -23,7 +23,7 @@
         <div>
             <p class="heading">Functions</p>
             <p class="title has-text-danger">
-                <abbr title="8 / 18">44.44 %</abbr></p>
+                <abbr title="8 / 28">28.57 %</abbr></p>
         </div>
     </div>
 
@@ -1131,7 +1131,7 @@
 </div>
         <footer class="footer">
             <div class="content has-text-centered">
-                <p class="heading">Date: 2023-09-06 16:49</p>
+                <p class="heading">Date: 2023-09-06 17:05</p>
             </div>
         </footer>
     </body>

diff --git a/docs/coverage/html/src/conventions/flat_case.rs.html b/docs/coverage/html/src/conventions/flat_case.rs.html
@@ -23,7 +23,7 @@
         <div>
             <p class="heading">Functions</p>
             <p class="title has-text-danger">
-                <abbr title="7 / 16">43.75 %</abbr></p>
+                <abbr title="7 / 25">28 %</abbr></p>
         </div>
     </div>
 
@@ -987,7 +987,7 @@
 </div>
         <footer class="footer">
             <div class="content has-text-centered">
-                <p class="heading">Date: 2023-09-06 16:49</p>
+                <p class="heading">Date: 2023-09-06 17:05</p>
             </div>
         </footer>
     </body>

diff --git a/docs/coverage/html/src/conventions/index.html b/docs/coverage/html/src/conventions/index.html
@@ -23,7 +23,7 @@
         <div>
             <p class="heading">Functions</p>
             <p class="title has-text-danger">
-                <abbr title="61 / 136">44.85 %</abbr></p>
+                <abbr title="61 / 212">28.77 %</abbr></p>
         </div>
     </div>
 
@@ -69,8 +69,8 @@
             40 / 57
         </td>
         <!-- -->
-        <td class="has-text-centered has-background-danger p-2">44.44%</td>
-        <td class="has-text-centered has-background-danger p-2">8 / 18 </td>
+        <td class="has-text-centered has-background-danger p-2">28.57%</td>
+        <td class="has-text-centered has-background-danger p-2">8 / 28 </td>
         <!-- -->
 
             <td class="has-text-centered has-background-success p-2">100%</td>
@@ -96,8 +96,8 @@
             33 / 52
         </td>
         <!-- -->
-        <td class="has-text-centered has-background-danger p-2">43.75%</td>
-        <td class="has-text-centered has-background-danger p-2">7 / 16 </td>
+        <td class="has-text-centered has-background-danger p-2">28%</td>
+        <td class="has-text-centered has-background-danger p-2">7 / 25 </td>
         <!-- -->
 
             <td class="has-text-centered has-background-success p-2">100%</td>
@@ -123,8 +123,8 @@
             33 / 52
         </td>
         <!-- -->
-        <td class="has-text-centered has-background-danger p-2">43.75%</td>
-        <td class="has-text-centered has-background-danger p-2">7 / 16 </td>
+        <td class="has-text-centered has-background-danger p-2">28%</td>
+        <td class="has-text-centered has-background-danger p-2">7 / 25 </td>
         <!-- -->
 
             <td class="has-text-centered has-background-success p-2">100%</td>
@@ -150,8 +150,8 @@
             33 / 52
         </td>
         <!-- -->
-        <td class="has-text-centered has-background-danger p-2">43.75%</td>
-        <td class="has-text-centered has-background-danger p-2">7 / 16 </td>
+        <td class="has-text-centered has-background-danger p-2">28%</td>
+        <td class="has-text-centered has-background-danger p-2">7 / 25 </td>
         <!-- -->
 
             <td class="has-text-centered has-background-success p-2">100%</td>
@@ -177,8 +177,8 @@
             47 / 65
         </td>
         <!-- -->
-        <td class="has-text-centered has-background-danger p-2">50%</td>
-        <td class="has-text-centered has-background-danger p-2">9 / 18 </td>
+        <td class="has-text-centered has-background-danger p-2">32.14%</td>
+        <td class="has-text-centered has-background-danger p-2">9 / 28 </td>
         <!-- -->
 
             <td class="has-text-centered has-background-success p-2">100%</td>
@@ -204,8 +204,8 @@
             43 / 62
         </td>
         <!-- -->
-        <td class="has-text-centered has-background-danger p-2">44.44%</td>
-        <td class="has-text-centered has-background-danger p-2">8 / 18 </td>
+        <td class="has-text-centered has-background-danger p-2">28.57%</td>
+        <td class="has-text-centered has-background-danger p-2">8 / 28 </td>
         <!-- -->
 
             <td class="has-text-centered has-background-success p-2">100%</td>
@@ -231,8 +231,8 @@
             33 / 52
         </td>
         <!-- -->
-        <td class="has-text-centered has-background-danger p-2">43.75%</td>
-        <td class="has-text-centered has-background-danger p-2">7 / 16 </td>
+        <td class="has-text-centered has-background-danger p-2">28%</td>
+        <td class="has-text-centered has-background-danger p-2">7 / 25 </td>
         <!-- -->
 
             <td class="has-text-centered has-background-success p-2">100%</td>
@@ -258,8 +258,8 @@
             43 / 62
         </td>
         <!-- -->
-        <td class="has-text-centered has-background-danger p-2">44.44%</td>
-        <td class="has-text-centered has-background-danger p-2">8 / 18 </td>
+        <td class="has-text-centered has-background-danger p-2">28.57%</td>
+        <td class="has-text-centered has-background-danger p-2">8 / 28 </td>
         <!-- -->
 
             <td class="has-text-centered has-background-success p-2">100%</td>
@@ -270,7 +270,7 @@
     </table></div>
         <footer class="footer">
             <div class="content has-text-centered">
-                <p class="heading">Date: 2023-09-06 16:49</p>
+                <p class="heading">Date: 2023-09-06 17:05</p>
             </div>
         </footer>
     </body>

diff --git a/docs/coverage/html/src/conventions/kebab_case.rs.html b/docs/coverage/html/src/conventions/kebab_case.rs.html
@@ -23,7 +23,7 @@
         <div>
             <p class="heading">Functions</p>
             <p class="title has-text-danger">
-                <abbr title="7 / 16">43.75 %</abbr></p>
+                <abbr title="7 / 25">28 %</abbr></p>
         </div>
     </div>
 
@@ -987,7 +987,7 @@
 </div>
         <footer class="footer">
             <div class="content has-text-centered">
-                <p class="heading">Date: 2023-09-06 16:49</p>
+                <p class="heading">Date: 2023-09-06 17:05</p>
             </div>
         </footer>
     </body>

diff --git a/docs/coverage/html/src/conventions/macro_case.rs.html b/docs/coverage/html/src/conventions/macro_case.rs.html
@@ -23,7 +23,7 @@
         <div>
             <p class="heading">Functions</p>
             <p class="title has-text-danger">
-                <abbr title="7 / 16">43.75 %</abbr></p>
+                <abbr title="7 / 25">28 %</abbr></p>
         </div>
     </div>
 
@@ -987,7 +987,7 @@
 </div>
         <footer class="footer">
             <div class="content has-text-centered">
-                <p class="heading">Date: 2023-09-06 16:49</p>
+                <p class="heading">Date: 2023-09-06 17:05</p>
             </div>
         </footer>
     </body>

diff --git a/docs/coverage/html/src/conventions/no_case.rs.html b/docs/coverage/html/src/conventions/no_case.rs.html
@@ -23,7 +23,7 @@
         <div>
             <p class="heading">Functions</p>
             <p class="title has-text-danger">
-                <abbr title="9 / 18">50 %</abbr></p>
+                <abbr title="9 / 28">32.14 %</abbr></p>
         </div>
     </div>
 
@@ -1195,7 +1195,7 @@
 </div>
         <footer class="footer">
             <div class="content has-text-centered">
-                <p class="heading">Date: 2023-09-06 16:49</p>
+                <p class="heading">Date: 2023-09-06 17:05</p>
             </div>
         </footer>
     </body>

diff --git a/docs/coverage/html/src/conventions/pascal_case.rs.html b/docs/coverage/html/src/conventions/pascal_case.rs.html
@@ -23,7 +23,7 @@
         <div>
             <p class="heading">Functions</p>
             <p class="title has-text-danger">
-                <abbr title="8 / 18">44.44 %</abbr></p>
+                <abbr title="8 / 28">28.57 %</abbr></p>
         </div>
     </div>
 
@@ -1179,7 +1179,7 @@
 </div>
         <footer class="footer">
             <div class="content has-text-centered">
-                <p class="heading">Date: 2023-09-06 16:49</p>
+                <p class="heading">Date: 2023-09-06 17:05</p>
             </div>
         </footer>
     </body>

diff --git a/docs/coverage/html/src/conventions/snake_case.rs.html b/docs/coverage/html/src/conventions/snake_case.rs.html
@@ -23,7 +23,7 @@
         <div>
             <p class="heading">Functions</p>
             <p class="title has-text-danger">
-                <abbr title="7 / 16">43.75 %</abbr></p>
+                <abbr title="7 / 25">28 %</abbr></p>
         </div>
     </div>
 
@@ -987,7 +987,7 @@
 </div>
         <footer class="footer">
             <div class="content has-text-centered">
-                <p class="heading">Date: 2023-09-06 16:49</p>
+                <p class="heading">Date: 2023-09-06 17:05</p>
             </div>
         </footer>
     </body>

diff --git a/docs/coverage/html/src/conventions/train_case.rs.html b/docs/coverage/html/src/conventions/train_case.rs.html
@@ -23,7 +23,7 @@
         <div>
             <p class="heading">Functions</p>
             <p class="title has-text-danger">
-                <abbr title="8 / 18">44.44 %</abbr></p>
+                <abbr title="8 / 28">28.57 %</abbr></p>
         </div>
     </div>
 
@@ -1179,7 +1179,7 @@
 </div>
         <footer class="footer">
             <div class="content has-text-centered">
-                <p class="heading">Date: 2023-09-06 16:49</p>
+                <p class="heading">Date: 2023-09-06 17:05</p>
             </div>
         </footer>
     </body>

diff --git a/docs/coverage/html/src/index.html b/docs/coverage/html/src/index.html
@@ -23,7 +23,7 @@
         <div>
             <p class="heading">Functions</p>
             <p class="title has-text-danger">
-                <abbr title="13 / 22">59.09 %</abbr></p>
+                <abbr title="13 / 35">37.14 %</abbr></p>
         </div>
     </div>
 
@@ -69,8 +69,8 @@
             16 / 23
         </td>
         <!-- -->
-        <td class="has-text-centered has-background-success p-2">100%</td>
-        <td class="has-text-centered has-background-success p-2">4 / 4 </td>
+        <td class="has-text-centered has-background-danger p-2">50%</td>
+        <td class="has-text-centered has-background-danger p-2">4 / 8 </td>
         <!-- -->
 
             <td class="has-text-centered has-background-success p-2">100%</td>
@@ -96,8 +96,8 @@
             35 / 35
         </td>
         <!-- -->
-        <td class="has-text-centered has-background-danger p-2">50%</td>
-        <td class="has-text-centered has-background-danger p-2">9 / 18 </td>
+        <td class="has-text-centered has-background-danger p-2">33.33%</td>
+        <td class="has-text-centered has-background-danger p-2">9 / 27 </td>
         <!-- -->
 
             <td class="has-text-centered has-background-success p-2">100%</td>
@@ -108,7 +108,7 @@
     </table></div>
         <footer class="footer">
             <div class="content has-text-centered">
-                <p class="heading">Date: 2023-09-06 16:49</p>
+                <p class="heading">Date: 2023-09-06 17:05</p>
             </div>
         </footer>
     </body>

diff --git a/docs/coverage/html/src/lib.rs.html b/docs/coverage/html/src/lib.rs.html
@@ -22,8 +22,8 @@
         <div class="level-item has-text-centered">
         <div>
             <p class="heading">Functions</p>
-            <p class="title has-text-success">
-                <abbr title="4 / 4">100 %</abbr></p>
+            <p class="title has-text-danger">
+                <abbr title="4 / 8">50 %</abbr></p>
         </div>
     </div>
 
@@ -1115,7 +1115,7 @@
 </div>
         <footer class="footer">
             <div class="content has-text-centered">
-                <p class="heading">Date: 2023-09-06 16:49</p>
+                <p class="heading">Date: 2023-09-06 17:05</p>
             </div>
         </footer>
     </body>

diff --git a/docs/coverage/html/src/tool.rs.html b/docs/coverage/html/src/tool.rs.html
@@ -23,7 +23,7 @@
         <div>
             <p class="heading">Functions</p>
             <p class="title has-text-danger">
-                <abbr title="9 / 18">50 %</abbr></p>
+                <abbr title="9 / 27">33.33 %</abbr></p>
         </div>
     </div>
 
@@ -843,7 +843,7 @@
 </div>
         <footer class="footer">
             <div class="content has-text-centered">
-                <p class="heading">Date: 2023-09-06 16:49</p>
+                <p class="heading">Date: 2023-09-06 17:05</p>
             </div>
         </footer>
     </body>