tschmidt-jplug 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.rdoc +34 -2
- data/VERSION +1 -1
- data/bin/jplug +2 -2
- data/jplug.gemspec +1 -1
- metadata +1 -1
data/README.rdoc
CHANGED
@@ -1,6 +1,38 @@
|
|
1
|
-
=
|
1
|
+
= jPlug
|
2
2
|
|
3
|
-
|
3
|
+
jPlug is a jQuery Plugin generator that is based on a template that I have been
|
4
|
+
using for a while now. It will generate a "shell" that has the file structure and
|
5
|
+
default styling that I like to use.
|
6
|
+
|
7
|
+
== Usage
|
8
|
+
|
9
|
+
To use this generator you must first install the gem
|
10
|
+
|
11
|
+
sudo gem install tschmidt-jplug
|
12
|
+
|
13
|
+
Once the gem has been installed you can type the following at the command line
|
14
|
+
|
15
|
+
jplug <plugin_name>
|
16
|
+
|
17
|
+
== Options
|
18
|
+
|
19
|
+
There are several options that can be set for jPlug. These include:
|
20
|
+
|
21
|
+
* author-name - Specify the author for this project.
|
22
|
+
* extras - Installs other useful jquery plugins.
|
23
|
+
* dest - Specify the default install directory. This will default to the current directory.
|
24
|
+
|
25
|
+
If you find that you are setting the same defaults each time you can create a .jplugrc
|
26
|
+
file in your home path. The format will be as follows:
|
27
|
+
|
28
|
+
author-name: Terry Schmidt
|
29
|
+
extras: false
|
30
|
+
dest: /path/to/install/directory
|
31
|
+
|
32
|
+
== Examples
|
33
|
+
|
34
|
+
jplug -a "Terry Schmidt" MyAwesomePlugin
|
35
|
+
jplug -a "Terry Schmdit" -d /Users/tschmidt/jq_plugins my_awesome_plugin
|
4
36
|
|
5
37
|
== Copyright
|
6
38
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
0.2.
|
1
|
+
0.2.1
|
data/bin/jplug
CHANGED
@@ -40,8 +40,8 @@ spec = Oyster.spec do
|
|
40
40
|
you can create a .jplugrc file in your home directory with the defaults that
|
41
41
|
you would like to have set every time. This file should be in the following format.
|
42
42
|
|
43
|
-
author-name
|
44
|
-
extras
|
43
|
+
author-name: Terry Schmidt
|
44
|
+
extras: false
|
45
45
|
NOTES
|
46
46
|
|
47
47
|
author 'Terry Schmidt'
|
data/jplug.gemspec
CHANGED