Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor improvements to the documentation #12

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Minor improvements to the documentation #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 `<my-github-username>` with your actual GitHub username.), like so:
Expand Down Expand Up @@ -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
2. https://egghead.io/lessons/javascript-how-to-write-a-javascript-library-unit-testing-with-mocha-and-chai