Skip to content
This repository was archived by the owner on Sep 11, 2018. It is now read-only.

Commit 6f5ecd2

Browse files
author
Claudio Ludovico Panetta
committed
Improve README
1 parent 85023bc commit 6f5ecd2

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,12 @@
1919

2020
- Either download or clone this repository
2121
- Run `npm install` this will install all the necessary tools from NPM
22-
- Run `npm run postinstall` this will create the dist folder
22+
- Run `npm run build` this will create the dist folder
2323
- Grab the file inside the dist folder and follow the [How to use section](#how-to-use)
2424

2525

2626
## How to use
27+
2728
This carousel is pretty easy to use. Put the source code inside your page:
2829

2930
<script src="dist/carousel.js"></script>
@@ -39,6 +40,7 @@ Try it with a source, for example you can use [Json Placeholder](http://jsonplac
3940

4041

4142
## Configuration
43+
4244
The current state of the component uses an array of `photos` object and it expects this attributes:
4345

4446
- albumId
@@ -51,6 +53,9 @@ The current state of the component uses an array of `photos` object and it expec
5153
you have to change the attributes of `selectedPhoto` and of `photos`. I will try to make this as dynamic as
5254
possible soon...
5355

56+
## Contributing
57+
58+
If you want to contribute to this project issues and pull requests are welcome!
5459

5560
## License
5661

0 commit comments

Comments
 (0)