Skip to content

Commit 69c0fb3

Browse files
joaquinbejarjoaquinbejar
committed
Refactor documentation and streamline README formatting.
Removed excessive badges and contact details from `src/lib.rs` for clarity. Updated README layout, added a template (`README.tpl`), and standardized the formatting for improved readability and maintainability.
1 parent e05283c commit 69c0fb3

3 files changed

Lines changed: 75 additions & 70 deletions

File tree

‎README.md‎

Lines changed: 29 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
1-
# optionstratlib
2-
3-
41
<div style="text-align: center;">
5-
<img src="https://raw.githubusercontent.com/joaquinbejar/OptionStratLib/refs/heads/main/doc/images/logo.png" alt="OptionStratLib" style="width: 531px; height: 221px;">
2+
<img src="https://raw.githubusercontent.com/joaquinbejar/OptionStratLib/refs/heads/main/doc/images/logo.png" alt="OptionStratLib" style="width: 90%; height: 90%;">
63
</div>
74

8-
[![Dual License](https://img.shields.io/badge/license-MIT%20and%20Apache%202.0-blue)](./LICENSE)
9-
[![Crates.io](https://img.shields.io/crates/v/optionstratlib.svg)](https://crates.io/crates/optionstratlib)
10-
[![Downloads](https://img.shields.io/crates/d/optionstratlib.svg)](https://crates.io/crates/optionstratlib)
11-
[![Stars](https://img.shields.io/github/stars/joaquinbejar/OptionStratLib.svg)](https://github.com/joaquinbejar/OptionStratLib/stargazers)
12-
[![Issues](https://img.shields.io/github/issues/joaquinbejar/OptionStratLib.svg)](https://github.com/joaquinbejar/OptionStratLib/issues)
13-
[![PRs](https://img.shields.io/github/issues-pr/joaquinbejar/OptionStratLib.svg)](https://github.com/joaquinbejar/OptionStratLib/pulls)
5+
[![Dual License](https://img.shields.io/badge/license-MIT%20and%20Apache%202.0-blue)](./LICENSE)
6+
[![Crates.io](https://img.shields.io/crates/v/optionstratlib.svg)](https://crates.io/crates/optionstratlib)
7+
[![Downloads](https://img.shields.io/crates/d/optionstratlib.svg)](https://crates.io/crates/optionstratlib)
8+
[![Stars](https://img.shields.io/github/stars/joaquinbejar/OptionStratLib.svg)](https://github.com/joaquinbejar/OptionStratLib/stargazers)
9+
[![Issues](https://img.shields.io/github/issues/joaquinbejar/OptionStratLib.svg)](https://github.com/joaquinbejar/OptionStratLib/issues)
10+
[![PRs](https://img.shields.io/github/issues-pr/joaquinbejar/OptionStratLib.svg)](https://github.com/joaquinbejar/OptionStratLib/pulls)
11+
[![Build Status](https://img.shields.io/github/workflow/status/joaquinbejar/OptionStratLib/CI)](https://github.com/joaquinbejar/OptionStratLib/actions)
12+
[![Coverage](https://img.shields.io/codecov/c/github/joaquinbejar/OptionStratLib)](https://codecov.io/gh/joaquinbejar/OptionStratLib)
13+
[![Dependencies](https://img.shields.io/librariesio/github/joaquinbejar/OptionStratLib)](https://libraries.io/github/joaquinbejar/OptionStratLib)
14+
[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://docs.rs/optionstratlib)
1415

1516

16-
[![Build Status](https://img.shields.io/github/workflow/status/joaquinbejar/OptionStratLib/CI)](https://github.com/joaquinbejar/OptionStratLib/actions)
17-
[![Coverage](https://img.shields.io/codecov/c/github/joaquinbejar/OptionStratLib)](https://codecov.io/gh/joaquinbejar/OptionStratLib)
18-
[![Dependencies](https://img.shields.io/librariesio/github/joaquinbejar/OptionStratLib)](https://libraries.io/github/joaquinbejar/OptionStratLib)
19-
[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://docs.rs/optionstratlib)
2017

2118
# OptionStratLib v0.4.4: Financial Options Library
2219

@@ -425,7 +422,8 @@
425422
bull_high_lim_opt --> bull_call(("Bull Call Spread"))
426423
bull_high_lim_stock --> protective_put(("Protective Put"))
427424
bull_high_unlim_opt --> long_call(("Long Call"))
428-
bull_high_unlim_stock --> pmcc@{ label: "Poor Man's Covered Call" }
425+
bull_high_unlim_stock --> pmcc((Poor Man's Covered Call))
426+
style pmcc shape:circle
429427
bull_low_lim_opt --> bull_put(("Bull Put Spread"))
430428
bull_low_lim_stock --> collar(("Collar"))
431429
bull_low_unlim_opt --> naked_put(("Naked Put"))
@@ -460,8 +458,6 @@
460458
neut_high_unlim_stock --> reversal(("Reversal"))
461459
neut_low_lim_stock --> married_combo(("Married Combo"))
462460
neut_low_unlim_stock --> ratio_spread(("Ratio Spread"))
463-
pmcc@{ shape: circle}
464-
465461
```
466462

467463
## Setup Instructions
@@ -670,24 +666,27 @@ setup_logger();
670666
make coverage
671667
```
672668

673-
## Contribution and Contact
674669

675-
We welcome contributions to this project! If you would like to contribute, please follow these steps:
676670

677-
1. Fork the repository.
678-
2. Create a new branch for your feature or bug fix.
679-
3. Make your changes and ensure that the project still builds and all tests pass.
680-
4. Commit your changes and push your branch to your forked repository.
681-
5. Submit a pull request to the main repository.
682671

683-
If you have any questions, issues, or would like to provide feedback, please feel free to contact the project maintainer:
672+
## Contribution and Contact
673+
674+
We welcome contributions to this project! If you would like to contribute, please follow these steps:
675+
676+
1. Fork the repository.
677+
2. Create a new branch for your feature or bug fix.
678+
3. Make your changes and ensure that the project still builds and all tests pass.
679+
4. Commit your changes and push your branch to your forked repository.
680+
5. Submit a pull request to the main repository.
684681

685-
**Joaquín Béjar García**
686-
- Email: jb@taunais.com
687-
- GitHub: [joaquinbejar](https://github.com/joaquinbejar)
682+
If you have any questions, issues, or would like to provide feedback, please feel free to contact the project maintainer:
688683

689-
We appreciate your interest and look forward to your contributions!
684+
**Joaquín Béjar García**
685+
- Email: jb@taunais.com
686+
- GitHub: [joaquinbejar](https://github.com/joaquinbejar)
690687

688+
We appreciate your interest and look forward to your contributions!
691689

690+
## ✍️ License
692691

693-
License: MIT
692+
Licensed under MIT license

‎README.tpl‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<div style="text-align: center;">
2+
<img src="https://raw.githubusercontent.com/joaquinbejar/OptionStratLib/refs/heads/main/doc/images/logo.png" alt="OptionStratLib" style="width: 90%; height: 90%;">
3+
</div>
4+
5+
[![Dual License](https://img.shields.io/badge/license-MIT%20and%20Apache%202.0-blue)](./LICENSE)
6+
[![Crates.io](https://img.shields.io/crates/v/optionstratlib.svg)](https://crates.io/crates/optionstratlib)
7+
[![Downloads](https://img.shields.io/crates/d/optionstratlib.svg)](https://crates.io/crates/optionstratlib)
8+
[![Stars](https://img.shields.io/github/stars/joaquinbejar/OptionStratLib.svg)](https://github.com/joaquinbejar/OptionStratLib/stargazers)
9+
[![Issues](https://img.shields.io/github/issues/joaquinbejar/OptionStratLib.svg)](https://github.com/joaquinbejar/OptionStratLib/issues)
10+
[![PRs](https://img.shields.io/github/issues-pr/joaquinbejar/OptionStratLib.svg)](https://github.com/joaquinbejar/OptionStratLib/pulls)
11+
[![Build Status](https://img.shields.io/github/workflow/status/joaquinbejar/OptionStratLib/CI)](https://github.com/joaquinbejar/OptionStratLib/actions)
12+
[![Coverage](https://img.shields.io/codecov/c/github/joaquinbejar/OptionStratLib)](https://codecov.io/gh/joaquinbejar/OptionStratLib)
13+
[![Dependencies](https://img.shields.io/librariesio/github/joaquinbejar/OptionStratLib)](https://libraries.io/github/joaquinbejar/OptionStratLib)
14+
[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://docs.rs/optionstratlib)
15+
16+
17+
18+
{{readme}}
19+
20+
21+
22+
## Contribution and Contact
23+
24+
We welcome contributions to this project! If you would like to contribute, please follow these steps:
25+
26+
1. Fork the repository.
27+
2. Create a new branch for your feature or bug fix.
28+
3. Make your changes and ensure that the project still builds and all tests pass.
29+
4. Commit your changes and push your branch to your forked repository.
30+
5. Submit a pull request to the main repository.
31+
32+
If you have any questions, issues, or would like to provide feedback, please feel free to contact the project maintainer:
33+
34+
**Joaquín Béjar García**
35+
- Email: jb@taunais.com
36+
- GitHub: [joaquinbejar](https://github.com/joaquinbejar)
37+
38+
We appreciate your interest and look forward to your contributions!
39+
40+
## ✍️ License
41+
42+
Licensed under MIT license

‎src/lib.rs‎

Lines changed: 4 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,7 @@
11
#![allow(unknown_lints)]
22
#![allow(clippy::literal_string_with_formatting_args)]
33

4-
//!
5-
//! <div style="text-align: center;">
6-
//! <img src="https://raw.githubusercontent.com/joaquinbejar/OptionStratLib/refs/heads/main/doc/images/logo.png" alt="OptionStratLib" style="width: 531px; height: 221px;">
7-
//! </div>
8-
//!
9-
//! [![Dual License](https://img.shields.io/badge/license-MIT%20and%20Apache%202.0-blue)](./LICENSE)
10-
//! [![Crates.io](https://img.shields.io/crates/v/optionstratlib.svg)](https://crates.io/crates/optionstratlib)
11-
//! [![Downloads](https://img.shields.io/crates/d/optionstratlib.svg)](https://crates.io/crates/optionstratlib)
12-
//! [![Stars](https://img.shields.io/github/stars/joaquinbejar/OptionStratLib.svg)](https://github.com/joaquinbejar/OptionStratLib/stargazers)
13-
//! [![Issues](https://img.shields.io/github/issues/joaquinbejar/OptionStratLib.svg)](https://github.com/joaquinbejar/OptionStratLib/issues)
14-
//! [![PRs](https://img.shields.io/github/issues-pr/joaquinbejar/OptionStratLib.svg)](https://github.com/joaquinbejar/OptionStratLib/pulls)
15-
//!
16-
//!
17-
//! [![Build Status](https://img.shields.io/github/workflow/status/joaquinbejar/OptionStratLib/CI)](https://github.com/joaquinbejar/OptionStratLib/actions)
18-
//! [![Coverage](https://img.shields.io/codecov/c/github/joaquinbejar/OptionStratLib)](https://codecov.io/gh/joaquinbejar/OptionStratLib)
19-
//! [![Dependencies](https://img.shields.io/librariesio/github/joaquinbejar/OptionStratLib)](https://libraries.io/github/joaquinbejar/OptionStratLib)
20-
//! [![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://docs.rs/optionstratlib)
21-
//!
4+
225
//! # OptionStratLib v0.4.4: Financial Options Library
236
//!
247
//! ## Table of Contents
@@ -426,7 +409,8 @@
426409
//! bull_high_lim_opt --> bull_call(("Bull Call Spread"))
427410
//! bull_high_lim_stock --> protective_put(("Protective Put"))
428411
//! bull_high_unlim_opt --> long_call(("Long Call"))
429-
//! bull_high_unlim_stock --> pmcc@{ label: "Poor Man's Covered Call" }
412+
//! bull_high_unlim_stock --> pmcc((Poor Man's Covered Call))
413+
//! style pmcc shape:circle
430414
//! bull_low_lim_opt --> bull_put(("Bull Put Spread"))
431415
//! bull_low_lim_stock --> collar(("Collar"))
432416
//! bull_low_unlim_opt --> naked_put(("Naked Put"))
@@ -461,8 +445,6 @@
461445
//! neut_high_unlim_stock --> reversal(("Reversal"))
462446
//! neut_low_lim_stock --> married_combo(("Married Combo"))
463447
//! neut_low_unlim_stock --> ratio_spread(("Ratio Spread"))
464-
//! pmcc@{ shape: circle}
465-
//!
466448
//! ```
467449
//!
468450
//! ## Setup Instructions
@@ -671,25 +653,7 @@
671653
//! make coverage
672654
//! ```
673655
//!
674-
//! ## Contribution and Contact
675-
//!
676-
//! We welcome contributions to this project! If you would like to contribute, please follow these steps:
677-
//!
678-
//! 1. Fork the repository.
679-
//! 2. Create a new branch for your feature or bug fix.
680-
//! 3. Make your changes and ensure that the project still builds and all tests pass.
681-
//! 4. Commit your changes and push your branch to your forked repository.
682-
//! 5. Submit a pull request to the main repository.
683-
//!
684-
//! If you have any questions, issues, or would like to provide feedback, please feel free to contact the project maintainer:
685-
//!
686-
//! **Joaquín Béjar García**
687-
//! - Email: jb@taunais.com
688-
//! - GitHub: [joaquinbejar](https://github.com/joaquinbejar)
689-
//!
690-
//! We appreciate your interest and look forward to your contributions!
691-
//!
692-
//!
656+
693657

694658
/// # OptionsStratLib: Financial Options Trading Library
695659
///

0 commit comments

Comments
 (0)