-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
nzambello
committed
Sep 21, 2017
1 parent
a8b47dd
commit b1f068e
Showing
1 changed file
with
6 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,15 @@ | ||
# How to contribute | ||
If you're interested, contributors are welcome! | ||
|
||
As a frontend developer, I looked for a solution like this many times, but anything worked really well. So I decided to write my JS function. | ||
As a frontend developer, I looked for a solution like this many times, but anything worked really well. So I decided to write my own JS function. | ||
You can use this library and help make this better! | ||
|
||
## What ellipsed needs | ||
* Passion, love and optimization. It is at the first development stage: it works. It works well but it needs optimization. | ||
* Perhaps a better README or documentation. | ||
|
||
If you can help in any way - coding, writing documentation or correcting my basic English - create a branch and a pull request! | ||
If you can help in any way - coding, writing documentation or correcting my basic English - fork this repo and create a pull request! | ||
|
||
## Getting started | ||
I usually use yarn. You can install `serve` with ```yarn install``` and try the example web page by typing: ```yarn start```. | ||
For testing or development, you can use that example page. | ||
|
||
In the `src` folder you can find the source code, which is written in ES6 and compiled with babel. To build it, run `yarn build`, alternatively you can run `yarn watch` to keep babel running and automatically compiling your changes to the source code. | ||
In the `src/` folder you can find the source code, which is written in ES6 and compiled with babel. To build it, run `yarn build`, alternatively you can run `yarn watch` to keep babel running and automatically compiling your changes to the source code. | ||
|
||
If you're interested in contributing, you can start with open issues or testing and reviewing code and documentation. |