Merge pull request #13 from 403-html/refine-readme

Refine readme

Author: Tymoteusz

README.md

@@ -1,2 +1,61 @@
-# javascript-coding-challenges
-Here I will put my challenges with how I resolve it. Feel free to fork by yourself.
+# Javascript Coding Challenges
+
+![Version](https://img.shields.io/github/package-json/v/403-html/javascript-coding-challenges)
+![Last commit](https://img.shields.io/github/last-commit/403-html/javascript-coding-challenges)
+![Jest version](https://img.shields.io/badge/testing%20library-jest-blue)
+![Language](https://img.shields.io/github/languages/top/403-html/javascript-coding-challenges)
+
+## Description
+
+> Sample coding challenges. You can write and test it right away.
+
+A repository for testing and storing programming tasks. Due to the added tests, it is possible to control your own capabilities.
+
+It's not perfect, so if you see a bug in the solution or within tests, it will be great if you share your thoughts on the subject, for example, as an issue or creating a PR.
+
+## How to work with it
+
+First, you have to clone the project
+
+```
+git clone https://github.com/403-html/javascript-coding-challenges.git
+```
+
+then install all dependencies
+
+for npm
+
+```
+npm install
+```
+
+or yarn
+
+```
+yarn install
+```
+
+Then search for an interesting challenge, for example, `prime-number`.
+Read the `README.md` in that folder. Write your solution in a javascript file dedicated to this folder (in our case, `isPrime.js`). There is a special place dedicated to doing that.
+
+If you're sure it's all good, go to the `__tests__` folder and open the test file. Remove the `.skip` method in tests and save.
+
+Run tests by npm
+
+```
+npm run prime-number
+```
+
+or if you're using yarn
+
+```
+yarn run prime-number
+```
+
+**If you take another task to do, just use the name of the task folder instead of `prime-number`.**
+
+**Enjoy!**
+
+## Contributors
+
+> Author: Tymoteusz '403-html' Stępień

package.json

@@ -1,11 +1,16 @@
 {
     "name": "javascript-coding-challenges",
-    "version": "0.1.0",
+    "version": "0.2.0",
     "description": "My JS challenges with how I resolve them",
     "main": "index.js",
     "scripts": {
         "test-all": "jest --passWithNoTests --json --outputFile=result.json --testLocationInResults",
-        "test-customs": "jest --passWithNoTests -o"
+        "test-customs": "jest --passWithNoTests -o",
+        "binary-tree": "jest binary-tree/__tests__/binary-tree.spec.js",
+        "fizzbuzz": "jest fizzbuzz/__tests__/fizzbuzz.spec.js",
+        "pigeons": "jest pigeons/__tests__/pigeons.spec.js",
+        "prime-number": "jest prime-number/__tests__/isPrime.spec.js",
+        "randsum": "jest randsum/__tests__/randsum.spec.js"
     },
     "repository": {
         "type": "git",

pigeons-challenge/README.md pigeons/README.mdpigeons-challenge/README.md renamed to pigeons/README.md

@@ -1,11 +1,11 @@
-# Random N-numbers sum which is equal to 0
-
-Write a function that as an argument gets the integer N `(1 < N < 100)`.
-
-This function is to return an `array` that contains unique `N` random numbers in the range `-100` to `100`, and besides that the sum of these numbers must always go to `0`.
-
-For example, for `N = 4` array `[-1, -2, 0, 3]`
-
----
-
-**Enjoy**
+# Random N-numbers sum which is equal to 0
+
+Write a function that as an argument gets the integer N `(1 < N < 100)`.
+
+This function is to return an `array` that contains unique `N` random numbers in the range `-100` to `100`, and besides that the sum of these numbers must always go to `0`.
+
+For example, for `N = 4` array `[-1, -2, 0, 3]`
+
+---
+
+**Enjoy**