parth10606_first_crate 0.1.1

A test lib for publishing
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

# parth10606_first_crate

[![Crates.io](https://img.shields.io/crates/v/parth10606_first_crate.svg)](https://crates.io/crates/parth10606_first_crate)
[![Docs.rs](https://docs.rs/parth10606_first_crate/badge.svg)](https://docs.rs/parth10606_first_crate)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

A modular, production-ready Rust crate that demonstrates clean project architecture, reusable utilities, and core logic.

---

## ✨ Features

- 🧠 **Core Modules** — Includes logic processors under `core/`
- 🔢 **Math Utilities** — Handy numeric functions like addition, subtraction, etc.
- 🔤 **String Utilities** — Functions to manipulate and format strings
- 📅 **Date Utilities** — Smart date formatting powered by `chrono`
- 🧪 **Well-tested** — Unit tests, doctests, and integration tests across all modules

---

## 📦 Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
parth10606_first_crate = "0.1"
```

---

## 🚀 Quick Start

```rust
use parth10606_first_crate::utils::math::add;

fn main() {
    let result = add(10, 5);
    println!("10 + 5 = {}", result);
}
```

---

## 📚 Documentation

View full documentation at [docs.rs/parth10606_first_crate](https://docs.rs/parth10606_first_crate)

To build locally:

```bash
cargo doc --open
```

---

## 📁 Examples

This crate includes runnable examples in the `examples/` folder.

To run an example:

```bash
cargo run --example math_usage.rs
```

To reference an example in documentation:

```rust
//! ```no_run
//! // See examples/usage.rs
//! use parth10606_first_crate::utils::string::reverse;
//! println!("{}", reverse("hello"));
//! ```
```

---

## 🧪 Testing

To run all tests (unit + integration + doc):

```bash
cargo test
```

---

## ✅ Roadmap

- [x] Modular folder structure
- [x] Unit + doc + integration tests
- [x] Clean `lib.rs` exports
- [x] Examples for users
- [ ] Add more real-world use cases
- [ ] Publish to crates.io

---

## 👥 Contributing

Pull requests, bug reports, and suggestions are welcome!  
Open an issue or fork and submit a PR.

---

## 📄 License

This project is licensed under the [MIT License](LICENSE).

---

## 🔗 Links

- [Crates.io](https://crates.io/crates/parth10606_first_crate)
- [Docs.rs](https://docs.rs/parth10606_first_crate)