From fecd4d560b3c7113b4dc3975ee115fe6b29b057f Mon Sep 17 00:00:00 2001 From: Kunal Date: Tue, 17 Jul 2018 22:50:09 -0700 Subject: [PATCH] Minor improvements to the documentation 1. Add long sentences increases the chances of readers attention. 2. Shorten the sentence, without losing the meaning of the sentence --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 75805bb..15baaaa 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,19 @@ # lodown -An npm functional programming library project - -In this project, you're going to create your own functional library of code and release this code for use through the `npm` (Node Package Management) platform. +Lodown is npm(Node Packet Management) base functional programming library. Lodown gives the developer the ability to create their personal functional programming library. Further, releasing the code for use through the `npm` (Node Package Management) platform. You'll then use your lodown library to solve problems in the next project. +Functional programming is a style of building the structure and elements of computer programs—that treats computation as the evaluation of mathematical functions and avoids changing-state and mutable data. + ## Setup -1. Fork this repository to your own GitHub account. -2. Clone your forked version of the lodown repository to a new Cloud9 workspace. -3. We'll need a `package.json` file, which describes for `npm` our library project and lists any dependant libraries of code. To create a `package.json` configuration file for our lodown library, from the command-line, run the command: +1. Fork the repository +2. Clone the forked reposittory to a new Cloud9 workspace +3. Create a 'package.json' file by running the following command: npm init + +Package.json file contains the code's dependent libraries and essential information() related to the project. + 4. **IMPORTANT CONFIGURATION**: Fill in the prompts with your own details: 1. When asked to name your lodown project, give it a unique name by appending your GitHub username to the name of the project (of course, replacing `` with your actual GitHub username.), like so: @@ -94,4 +97,4 @@ If you want to learn about and create unit tests for your code, write your tests ### Quick Videos 1. https://egghead.io/lessons/javascript-how-to-write-a-javascript-library-setting-up-unit-testing-with-mocha-and-chai -2. https://egghead.io/lessons/javascript-how-to-write-a-javascript-library-unit-testing-with-mocha-and-chai \ No newline at end of file +2. https://egghead.io/lessons/javascript-how-to-write-a-javascript-library-unit-testing-with-mocha-and-chai