Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vitaly-t committed Oct 23, 2021
1 parent f33610b commit a2dbd90
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,16 @@ prime-lib

## About

This [prime number] generator combines performance of [Sieve of Eratosthenes] algorithm with the maximum memory
efficiency. It was designed to be [RXJS]-friendly, and well suited for web app-s.
Popular [prime number] functions, implemented in TypeScript, with focus on memory efficiency and performance,
to be friendly for Web apps, and [RXJS] in particular.

* See [WiKi] to help decide which generator to use.
* Other resources: [tests](./test) and [benchmarks](./benchmarks).
It features many well-known optimization methods, such as [Sieve of Eratosthenes], [Meissel Lehmer], etc.

See the following resources:

* [API](#api) - all available functions
* [WiKi] - to help choose a prime generator
* [Benchmarks](./benchmarks) - to see the performance

## Installation

Expand Down Expand Up @@ -142,4 +147,4 @@ Work-in-progress:

[RXJS]:https://github.com/ReactiveX/rxjs

[Meissel Lehmer algorithm]:https://en.wikipedia.org/wiki/Meissel%E2%80%93Lehmer_algorithm
[Meissel Lehmer]:https://en.wikipedia.org/wiki/Meissel%E2%80%93Lehmer_algorithm
7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "prime-lib",
"version": "0.2.14",
"version": "0.2.15",
"description": "Prime number library",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand All @@ -27,9 +27,10 @@
"prime",
"primes",
"generator",
"generators",
"sieve",
"eratosthenes"
"eratosthenes",
"meissel",
"lehmer"
],
"author": {
"name": "Vitaly Tomilov",
Expand Down

0 comments on commit a2dbd90

Please sign in to comment.