Skip to content

Commit 484554c

Browse files
committed
docs: fix markdown rendering for GitHub display
Add proper Markdown list syntax and HTML line breaks to ensure correct rendering on GitHub. Changes: - Features section: Convert to proper Markdown list with dash prefixes - Copyright header: Add <br> tags for line breaks between metadata fields This ensures the README displays correctly on GitHub with: - Each feature as a separate bulleted list item - Each metadata field (Version, Date, License, etc.) on its own line
1 parent 282fde0 commit 484554c

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# Functional - Type-Safe Error Handling for Ada 2022
22

3-
**Version:** 1.0.0
4-
**Date:** October 25, 2025
5-
**SPDX-License-Identifier:** BSD-3-Clause
6-
**License File:** See the LICENSE file in the project root.
7-
**Copyright:** © 2025 Michael Gardner, A Bit of Help, Inc.
3+
**Version:** 1.0.0<br>
4+
**Date:** October 25, 2025<br>
5+
**SPDX-License-Identifier:** BSD-3-Clause<br>
6+
**License File:** See the LICENSE file in the project root.<br>
7+
**Copyright:** © 2025 Michael Gardner, A Bit of Help, Inc.<br>
88
**Status:** Release
99

1010
A clean, Ada-idiomatic library providing `Result<T,E>`, `Option<T>`, and `Either<L,R>` types for functional error handling in Ada 2022.
1111

1212
## Features
1313

14-
**Result<T,E>** - Type-safe error handling (17 operations)
15-
**Option<T>** - Optional values (11 operations)
16-
**Either<L,R>** - Disjoint union type (8 operations)
17-
**Try.To_Result** - Convert exceptions to Result
18-
**Try.To_Option** - Convert exceptions to Option
19-
**Pure packages** - No side effects, compile-time guarantees
20-
**Zero dependencies** - Just Ada 2022 standard library
21-
**Production ready** - Comprehensive compiler checks and style enforcement
14+
- **Result<T,E>** - Type-safe error handling (17 operations)
15+
- **Option<T>** - Optional values (11 operations)
16+
- **Either<L,R>** - Disjoint union type (8 operations)
17+
- **Try.To_Result** - Convert exceptions to Result
18+
- **Try.To_Option** - Convert exceptions to Option
19+
- **Pure packages** - No side effects, compile-time guarantees
20+
- **Zero dependencies** - Just Ada 2022 standard library
21+
- **Production ready** - Comprehensive compiler checks and style enforcement
2222

2323
## Installation
2424

0 commit comments

Comments
 (0)