Skip to content

Commit

Permalink
Minor fixes to documentation and website
Browse files Browse the repository at this point in the history
  • Loading branch information
nir9 committed Aug 15, 2022
1 parent b2b2d21 commit 298c93c
Show file tree
Hide file tree
Showing 8 changed files with 153 additions and 156 deletions.
20 changes: 9 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,32 @@
### Issues

Please provide jsFiddle examples as well when reporting bugs.
Please provide code examples as well when reporting bugs.

### Pull requests

1. Please make your changes to the plugin code in the `/src` files, and not in the `/dist` files.
2. To test your code use `/testing/index.html`.
3. Keep your pull request simple and avoid doing any unintended changes.
4. Don't commit any changes to `/dist/itemslide.min.js`
1. Keep your pull request simple and avoid doing any unintended changes.
1. Don't commit any changes to `/dist/itemslide.min.js`

This project is built using Browserify so if you want to contribute make sure you have a basic understanding of it.
This project is built using webpack so if you want to contribute make sure you have a basic understanding of it.

#### Building

Before starting make sure you have Node.js installed on your system.

First install the devDependencies by typing-
First install the dependencies by typing:

```bash
npm install
```

You can use watch so that itemslide will be built as you make changes to the `/src` files:
You can use watch so that ItemSlide will be built as you make changes to the `/src` files:

```bash
npm run-script watch
npm run watch
```

Or manually build the project using:
Or build the project using:

```bash
npm run-script testing-build
npm run build
```
4 changes: 2 additions & 2 deletions dist/itemslide.min.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions dist/itemslide.min.js.LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/*! /* ItemSlide.js - Licensed under the MIT license - itemslide.org/license.html * / */
12 changes: 2 additions & 10 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,6 @@
</tr>
</table>

<!--END OF BUTTONS MENU-->

<span id="downloadarea">
<a href="website-src/download.html" id="download">DOWNLOAD</a> (10K)
</span>
Expand All @@ -71,10 +69,8 @@
</span>
</div>


<!--Here is the carousel-->
<!-- Here is the carousel -->
<div id="scrolling">
<!--Slider-->
<ul>
<li>
Swipe
Expand All @@ -89,19 +85,15 @@
Click to Slide
</li>
<li>
Mobile friendly
Mobile Friendly
</li>
</ul>
</div>

<div id="fotter" align="center">



<!--Social Links-->
<span id="links">
<iframe src="https://ghbtns.com/github-btn.html?user=nir9&repo=itemslide&type=star&count=true" frameborder="0" scrolling="0" width="170px" height="20px"></iframe>
<!--Twitter-->
<div id="twitterwrap">
<a href="https://twitter.com/share" class="twitter-share-button" data-url="https://itemslide.org/" data-text="A simple and beautiful JavaScript touch carousel" data-hashtags="itemsilde">Tweet</a></div>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
Expand Down
2 changes: 1 addition & 1 deletion license.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

The MIT License (MIT) <br/>

Copyright (c) 2020 Nir Lichtman &lt;nir.lich@gmail.com&gt; <br/>
Copyright (c) 2022 Nir Lichtman &lt;nir.lich@gmail.com&gt; <br/>

Permission is hereby granted, free of charge, to any person obtaining a copy <br/>
of this software and associated documentation files (the "Software"), to deal <br/>
Expand Down
183 changes: 138 additions & 45 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion testing/README.md

This file was deleted.

Loading

0 comments on commit 298c93c

Please sign in to comment.