add docs for bogosort

abranhe · abranhe · commit aa8847b87442 · 2019-02-21T20:45:16.000-05:00
diff --git a/changelog.md b/changelog.md
@@ -1,20 +1,17 @@
-<div align="left">
-<h1><img src="https://cdn.abranhe.com/projects/algorithms/algorithms.svg" alt="Algorithms" height="30px">
-<img src="https://cdn.abranhe.com/projects/algorithms/logos/javascript.svg" width="30px">
-Changelog
-</h1>
-<div>
+n.n.n / 2019-02-21
+==================
 
-# `0.0.2`
+  * Merge pull request #2 from christianbender/add_bogo_sort
 
-- Fix installing issue
+  * changed according to xo-tool
+  * added bogo sort
+  * package.json
+  * Merge pull request #1 from abranhe/donotdisturb
+  * no more notifications
+  * remove comma (,)
 
-# `0.0.1`
-
-Date: October 29, 2018
-
-> Algorithms:
-
-- **Sorting**
-  - Bubble Sort
-  - Merge Sort
+0.0.2 / 2018-10-29
+==================
+ 
+ * fix install issue && jump to 0.0.2
+ * init
diff --git a/docs/sorting/bogo-sort.md b/docs/sorting/bogo-sort.md
@@ -0,0 +1,30 @@
+# Bogo Sort
+
+In computer science, bogosort is a highly ineffective sorting function based on the generate and test paradigm. The function successively generates permutations of its input until it finds one that is sorted. It is not useful for sorting, but may be used for educational purposes, to contrast it with more efficient algorithms.
+
+## Install
+
+```
+npm install allalgorithms
+```
+
+## Usage
+
+```js
+const allalgorithms = require('allalgorithms');
+
+arr = [77, 2, 10, -2, 1, 7]
+
+console.log(allalgorithms.sorting.bogoSort(arr))
+// -> [-2, 1, 2, 7, 10, 77]
+```
+
+## API
+
+### bogoSort(array)
+
+> Returns a sorted array
+
+##### Params:
+
+- `array`: Unsorted Array
diff --git a/src/sorting.js b/src/sorting.js
@@ -1,5 +1,5 @@
 module.exports = {
+	bogoSort: require('./sorting/bogo-sort'),
 	bubbleSort: require('./sorting/bubble-sort'),
-	mergeSort: require('./sorting/merge-sort'),
-	bogoSort: require('./sorting/bogo-sort')
+	mergeSort: require('./sorting/merge-sort')
 };
