Skip to content

Commit

Permalink
[doc] Provide a simple introduction of the library
Browse files Browse the repository at this point in the history
  • Loading branch information
BioCrossCoder committed May 11, 2024
1 parent d77e219 commit 15e07cc
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,15 @@ A Golang library to make development easier and more efficient

## Features

1. Provide a series of functions with `JavaScript` style.
2. Provide a series of functions with `Python` style.
3. Provide a series of `Data Structure`.
4. Improve the support for `OOP` and `FP` in `Golang`.
1. `itertools` provide a series of functions to create iterators.
2. `functools` provide a series of functions to support functional programming.
3. `collections` provide a series of powerful and practical containers to store and manipulate data.
4. `typed` provide `itertools`, `functools` and `collections` with `generics` support.
5. This library mainly refers to `Python` and `JavaScript`, considering the feature of `Golang` as well.

## ToDo List

1. Robustness: Add fuzz tests to ensure the robustness of the library.
2. Maintainability: Add annotations to the code to make it more readable; standardize the naming of the functions and variables to make it more consistent.
3. Provide more practical functions in `functools` for manipulating `sequences` (`slice`/`array`/`string`).
4. Generate documentation for the library and provide examples for each function.

0 comments on commit 15e07cc

Please sign in to comment.