joe 0.0.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.
Files changed (2) hide show
  1. data/README.markdown +91 -0
  2. metadata +55 -0
data/README.markdown ADDED
@@ -0,0 +1,91 @@
1
+ Joe
2
+ ===
3
+
4
+ Release your gems to RubyForge, no pain involved.
5
+
6
+
7
+ Usage
8
+ -----
9
+
10
+ Joe assumes you have a .gemspec file in the current directory and it will use it to build the gem. Once you have it, try this:
11
+
12
+ $ thor joe:package
13
+
14
+ Congratulations, you should have your gem built and an archive copy inside the `pkg` directory.
15
+
16
+ Now go ahead and release your new gem to RubyForge:
17
+
18
+ $ thor joe:release
19
+
20
+ Easy, right? Wait a few minutes until RubyForge updates its gems index and you will be able to run `sudo gem install foo`.
21
+
22
+
23
+ Troubleshooting
24
+ ---------------
25
+
26
+ If you get an error about a missing `group_id`, try running `rubyforge config`. This hooks up your RubyForge account with the gem and configures where to release it.
27
+
28
+
29
+ Maintaining a gemspec file
30
+ --------------------------
31
+
32
+ The easiest way we've found to maintain a gemspec file is by creating a `foo.gemspec.erb` template ([see example](http://github.com/soveran/ohm/blob/e3ff3fb20c1337cb2c4de244e09ce9fa04ef397d/ohm.gemspec.erb)). Then you can use a Thor task to produce the real gemspec file:
33
+
34
+ $ thor joe:gemspec
35
+
36
+
37
+ Installation
38
+ ------------
39
+
40
+ You need the `rubyforge` gem in order to release files. If you don't have it already:
41
+
42
+ $ sudo gem install rubyforge
43
+ $ rubyforge setup
44
+ $ rubyforge config
45
+
46
+ Make sure you have Thor installed:
47
+
48
+ $ sudo gem install thor
49
+
50
+ And then simply:
51
+
52
+ $ thor install http://dimaion.com/joe/joe.thor
53
+
54
+ That's it. Try:
55
+
56
+ $ thor -T
57
+
58
+ And you will get a list of Thor tasks.
59
+
60
+
61
+ Thanks
62
+ ------
63
+
64
+ Thanks to Blake Mizerany for pointing us to the Sinatra Rakefile for reference.
65
+
66
+
67
+ License
68
+ -------
69
+
70
+ Copyright (c) 2009 Damian Janowski and Michel Martens
71
+
72
+ Permission is hereby granted, free of charge, to any person
73
+ obtaining a copy of this software and associated documentation
74
+ files (the "Software"), to deal in the Software without
75
+ restriction, including without limitation the rights to use,
76
+ copy, modify, merge, publish, distribute, sublicense, and/or sell
77
+ copies of the Software, and to permit persons to whom the
78
+ Software is furnished to do so, subject to the following
79
+ conditions:
80
+
81
+ The above copyright notice and this permission notice shall be
82
+ included in all copies or substantial portions of the Software.
83
+
84
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
85
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
86
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
87
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
88
+ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
89
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
90
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
91
+ OTHER DEALINGS IN THE SOFTWARE.
metadata ADDED
@@ -0,0 +1,55 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: joe
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Damian Janowski
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+
12
+ date: 2009-06-08 00:00:00 -03:00
13
+ default_executable:
14
+ dependencies: []
15
+
16
+ description:
17
+ email: damian.janowski@gmail.com
18
+ executables: []
19
+
20
+ extensions: []
21
+
22
+ extra_rdoc_files: []
23
+
24
+ files:
25
+ - README.markdown
26
+ has_rdoc: false
27
+ homepage: http://github.com/djanowski/joe
28
+ licenses: []
29
+
30
+ post_install_message:
31
+ rdoc_options: []
32
+
33
+ require_paths:
34
+ - lib
35
+ required_ruby_version: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - ">="
38
+ - !ruby/object:Gem::Version
39
+ version: "0"
40
+ version:
41
+ required_rubygems_version: !ruby/object:Gem::Requirement
42
+ requirements:
43
+ - - ">="
44
+ - !ruby/object:Gem::Version
45
+ version: "0"
46
+ version:
47
+ requirements: []
48
+
49
+ rubyforge_project:
50
+ rubygems_version: 1.3.2
51
+ signing_key:
52
+ specification_version: 2
53
+ summary: Release to RubyForge, the easy way.
54
+ test_files: []
55
+