Skip to content

Commit 84f2d97

Browse files
leocaseiroleocaseiro
committed
Version and Documentation Readme update
1 parent f7a9906 commit 84f2d97

File tree

6 files changed

+70
-37
lines changed

6 files changed

+70
-37
lines changed

Diff for: ‎README.md

+61-28
Original file line numberDiff line numberDiff line change
@@ -4,46 +4,79 @@ jQuery Plugin stringToSlug
44
A Simple Plugin in jQuery JavaScript Framework.
55
The stringToSlug converts any string to SLUG supporting all Languages using or not accent and special chars as well.
66

7+
Documentation
8+
--------------
9+
Full Documentation with Examples at [http://leocaseiro.github.io/jQuery-Plugin-stringToSlug/](http://leocaseiro.github.io/jQuery-Plugin-stringToSlug/)
10+
11+
712
Default Usage:
8-
-----------------
13+
--------------
914

10-
$(document).ready( function() {
11-
$("#string").stringToSlug();
12-
});
15+
```javascript
16+
$(document).ready( function() {
17+
$("#string").stringToSlug();
18+
});
19+
```
1320

1421

15-
[More in github page](http://leocaseiro.github.io/jQuery-Plugin-stringToSlug/)
22+
Install via Bower:
23+
-----------------
24+
```
25+
bower install --save jquery.stringtoslug
26+
```
1627

28+
[Download](https://github.com/leocaseiro/jQuery-Plugin-stringToSlug/archive/v2.0.0.zip):
29+
-----------------
30+
```
31+
[Click here to download the latest version](https://github.com/leocaseiro/jQuery-Plugin-stringToSlug/archive/v2.0.0.zip)
32+
```
1733

18-
The plugin removes special characters, converts the string to lowercase and defines a space character. You can set a prefix and/or suffix before to convert it.
34+
Description
35+
--------------
36+
The stringToSlug uses a third-party library speakingURL that removes special characters, converts the string to lowercase. The StringToSlug also defines a space character and set optionally a prefix and/or a suffix for your slug.
1937

2038
Transforming a string into a url-friendly permalink.
2139
You can use the plugin to display a view in html elements or form inputs.
2240

23-
It is the only plugin that removes the stress of words, exchanging letters marked by unaccented letters.
41+
Contributing
42+
------------
43+
The StringToSlug uses [**NodeJS with NPM**](http://nodejs.org/) and **Gulp** for compile, **Jasmine** and **Karma** for testing:
2444

25-
Features version 1.0.0:
26-
-----------------
27-
* Set one or more events to work (Default events are keyup, keydown and blur)
28-
* Set get input or element to view the slug (Ex: input[type=hidden] or span#slug)
29-
* Set character to space (Ex: hiphen or underscore)
45+
To install **Bower** and **Gulp** globally, use **npm install -g**:
46+
```shell
47+
npm install -g bower
48+
npm install -g gulp
49+
```
3050

31-
Features version 1.0.1:
32-
-----------------
33-
* a little upgrade for win-1250. Some czech letters more (by Ales)
51+
Install all dependencies with NPM and make sure Bower is up to date:
52+
```shell
53+
npm install
54+
bower install
55+
```
3456

35-
Features available with version 1.2.0
36-
-----------------
37-
* Set prefix (Ex: prefix table "tbl_")
38-
* Set suffix (Ex: file extension ".jpg")
39-
* Define replace regExpress before the slug be generated (Ex: remove text in parentheses)
57+
List all tasks with gulp
58+
```shell
59+
gulp
60+
```
4061

41-
Features available with version 1.2.1
42-
-----------------
43-
* Fixed error when use '_' or other char in space char
44-
* callback implemented // eq: function(text){ console.log(text); }
62+
Gulp Watcher for Development
63+
```shell
64+
gulp watcher
65+
```
4566

46-
Features available with version 1.3.0
47-
-----------------
48-
* Replace AND char
49-
* Fixed quote error following the ISSUE: Undefined chars #4
67+
Gulp Tests for Tests
68+
```shell
69+
gulp tests
70+
```
71+
72+
Gulp Build to Compile
73+
```shell
74+
gulp build
75+
```
76+
77+
78+
License
79+
------------
80+
Copyright (c) 2009-2015 Leo Caseiro. This is a free software is licensed under the MIT License.
81+
82+
[Leo Caseiro](http://about.me/leocaseiro)

Diff for: ‎bower.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "jQuery-Plugin-stringToSlug",
2+
"name": "jquery.stringtoslug",
33
"version": "2.0.0",
44
"homepage": "https://github.com/leocaseiro/jQuery-Plugin-stringToSlug",
55
"bugs": "https://github.com/leocaseiro/jQuery-Plugin-stringToSlug/issues",
@@ -8,7 +8,7 @@
88
],
99
"description": "Convert a STRING to a SLUG in any language using jQuery and SpeakingURL",
1010
"main": "dist/jquery.stringToSlug.min.js",
11-
"license": "GPL 3.0",
11+
"license": "MIT",
1212
"ignore": [
1313
"**/.*",
1414
"node_modules",

Diff for: ‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
"url": "git+https://github.com/leocaseiro/jQuery-Plugin-stringToSlug.git"
2929
},
3030
"author": "Leo Caseiro",
31-
"license": "GPL-3.0",
31+
"license": "MIT",
3232
"bugs": {
3333
"url": "https://github.com/leocaseiro/jQuery-Plugin-stringToSlug/issues"
3434
},

Diff for: ‎samples.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@
7777
<h1 class="sts-title"><i class="fa fa-exchange"></i> jQuery StringToSlug</h1>
7878
<p class="sts-subtitle">Convert any string into slugs and bind using jQuery</p>
7979
<p>
80-
<a href="https://github.com/leocaseiro/jQuery-Plugin-stringToSlug/archive/v1.3.0.zip" class="btn btn-lg btn-white btn-outline"> <i class="glyphicon glyphicon-download-alt"></i> Download 2.0.0 (zip)</a>
81-
<a href="https://github.com/leocaseiro/jQuery-Plugin-stringToSlug/archive/v1.3.0.tar.gz" class="btn btn-lg btn-white btn-outline"> <i class="glyphicon glyphicon-download-alt"></i> Download 2.0.0 (tar.gz)</a>
80+
<a href="https://github.com/leocaseiro/jQuery-Plugin-stringToSlug/archive/v2.0.0.zip" class="btn btn-lg btn-white btn-outline"> <i class="glyphicon glyphicon-download-alt"></i> Download 2.0.0 (zip)</a>
81+
<a href="https://github.com/leocaseiro/jQuery-Plugin-stringToSlug/archive/v2.0.0.tar.gz" class="btn btn-lg btn-white btn-outline"> <i class="glyphicon glyphicon-download-alt"></i> Download 2.0.0 (tar.gz)</a>
8282
<a href="https://github.com/leocaseiro/jQuery-Plugin-stringToSlug" class="btn btn-lg btn-white btn-outline"> <i class="fa fa-github"></i> View on Github</a>
8383
</p>
8484

Diff for: ‎src/jquery.stringToSlug.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
/*
22
* jQuery stringToSlug plug-in 2.0.0
33
*
4-
* Plugin HomePage http://leocaseiro.com.br/jquery-plugin-string-to-slug/
4+
* Documentation http://leocaseiro.github.io/jQuery-Plugin-stringToSlug/
55
*
6-
* Copyright (c) 2009 Leo Caseiro
6+
* Copyright (c) 2009-2015 Leo Caseiro
77
*
88
* v1 Based on [Edson Hilios](http://www.edsonhilios.com.br/) Algorithm
99
* v2 Uses [SpeakingURL](https://github.com/pid/speakingurl)

Diff for: ‎stringToSlug.jquery.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@
2424
"licenses": [
2525
{
2626
"type": "MIT",
27-
"url": "http://www.opensource.org/licenses/mit-license.php"
27+
"url": "http://opensource.org/licenses/MIT"
2828
}
2929
],
3030
"bugs": "https://github.com/leocaseiro/jQuery-Plugin-stringToSlug/issues",
3131
"homepage": "http://leocaseiro.github.io/jQuery-Plugin-stringToSlug/",
3232
"docs": "http://leocaseiro.github.io/jQuery-Plugin-stringToSlug/",
33-
"download": "https://github.com/leocaseiro/jQuery-Plugin-stringToSlug/archive/1.3.0.zip",
33+
"download": "https://github.com/leocaseiro/jQuery-Plugin-stringToSlug/archive/2.0.0.zip",
3434
"dependencies": {
3535
"jquery": ">=1.2.2"
3636
}

0 commit comments

Comments
 (0)