diff --git a/.changeset/afraid-owls-taste.md b/.changeset/afraid-owls-taste.md deleted file mode 100644 index 12f970e..0000000 --- a/.changeset/afraid-owls-taste.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"sortman": patch ---- - -Fix sort test and sort benchmark diff --git a/.changeset/clear-rats-stand.md b/.changeset/clear-rats-stand.md deleted file mode 100644 index f467c59..0000000 --- a/.changeset/clear-rats-stand.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"sortman": patch ---- - -Fix desc option in sort check 's error diff --git a/.changeset/dark-maps-clap.md b/.changeset/dark-maps-clap.md deleted file mode 100644 index 89cc389..0000000 --- a/.changeset/dark-maps-clap.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"sortman": patch ---- - -add option test diff --git a/.changeset/green-rooms-rush.md b/.changeset/green-rooms-rush.md deleted file mode 100644 index 18e94eb..0000000 --- a/.changeset/green-rooms-rush.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"sortman": patch ---- - -Add options diff --git a/.changeset/rotten-forks-tap.md b/.changeset/rotten-forks-tap.md deleted file mode 100644 index 2752f9c..0000000 --- a/.changeset/rotten-forks-tap.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"sortman": major ---- - -Add contribution guide diff --git a/.changeset/stale-tables-allow.md b/.changeset/stale-tables-allow.md deleted file mode 100644 index f0b341a..0000000 --- a/.changeset/stale-tables-allow.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"sortman": major ---- - -Add security.md diff --git a/.changeset/tired-lights-film.md b/.changeset/tired-lights-film.md deleted file mode 100644 index 6011a90..0000000 --- a/.changeset/tired-lights-film.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"sortman": patch ---- - -Add shell sort diff --git a/.changeset/wise-signs-listen.md b/.changeset/wise-signs-listen.md deleted file mode 100644 index 34191e2..0000000 --- a/.changeset/wise-signs-listen.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"sortman": patch ---- - -Delete: reference args diff --git a/CHANGELOG.md b/CHANGELOG.md index ec1db6d..2d8600b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,22 @@ # sortman +## 1.0.0 + +### Major Changes + +- c194b2c: Fix readme.md +- 6e1ddda: Add contribution guide +- 507b452: Add security.md + +### Patch Changes + +- 3c93962: Fix sort test and sort benchmark +- cd7af65: Fix desc option in sort check 's error +- 702bef5: add option test +- 09c7e15: Add options +- 3151851: Add shell sort +- 014f39e: Delete: reference args + ## 0.0.6 ### Patch Changes diff --git a/README.md b/README.md index 40c16a9..f6fca96 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,15 @@ -# sortman +# `SortMan` Sortman is sort lib in javascript. +Various sorting options are supported, including object sorting and switching between ascending and descending order. + +# Installation + +```console +npm install sortman +``` + # Usage ```ts @@ -37,6 +45,38 @@ const sorted = SortMan.sort({ console.log(sorted); ``` +# Support sorts + +- Bogo sort - `SortMan.bogo` +- Bubble sort - `SortMan.bubble` +- Heap sort - `SortMan.heap` +- Insertion sort - `SortMan.insertion` +- Merge sort - `SortMan.merge` +- Quick sort - `SortMan.quick` +- Selection sort - `SortMan.selection` +- Shell sort - `SortMan.shell` + +# Options + +## Desc + +By setting it to true, the output results will be in descending order. + +```ts +import { SortMan } from "sortman"; + +const data = [200, 300, 100]; + +const sorted = SortMan.sort({ + arr: data, + options: { + desc: true + } +}); + +console.log(sorted); +``` + # Repository https://github.com/ROBOTofficial/sortman