proteus-kits 0.2 → 0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (9) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +5 -15
  3. data/CONTRIBUTING.md +30 -0
  4. data/Gemfile +0 -1
  5. data/LICENSE.md +21 -0
  6. data/README.md +50 -25
  7. data/lib/proteus/version.rb +1 -1
  8. metadata +5 -5
  9. data/LICENSE.txt +0 -22
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 2ac3d48a1f19474312bcb47473714742d9a9efd5
4
- data.tar.gz: 38a878e28290e40d6c82b7a6f535d6ac51bb55bb
3
+ metadata.gz: 004a713b1130f26e77b51190546be6efd477f4cc
4
+ data.tar.gz: 05e9132e154788899bbaa986f28a1d593a2f41e0
5
5
  SHA512:
6
- metadata.gz: e3fb50fe471f9cafab6552815394fbbf0ad50927b8ddd8da411c03d89f21998ef04464b8951e76089cba84ff282e8ac2b4210cb447b81a9791a5f0035bb3b72f
7
- data.tar.gz: 4891ac18a1b5cbc9bb04673bbe300f9dd9e1b6ddd66bc1b14b6b60f47725899d6ada695786d60421b8ea813ad9626cf9fb588ff95a2bba678c4167a17190a3c1
6
+ metadata.gz: cfffd71b509b80f3bf260ee900677958db82db8ea1713ea03b8fc93133f2c352a0dfaf8739f5c370a1b2e729145ae53fff5eb817cdb56760a6888c0a2c6c594f
7
+ data.tar.gz: 5c65c5981468b8b59f11e9e68f351d89a30f0899309d530533dcdd0b8ada5c697739d56ae0a9e0c6882c160853edc7a7046f92cdca57228ad334e3e33c972dcb
data/.gitignore CHANGED
@@ -1,15 +1,5 @@
1
- /.bundle/
2
- /.yardoc
3
- /Gemfile.lock
4
- /_yardoc/
5
- /coverage/
6
- /doc/
7
- /pkg/
8
- /spec/reports/
9
- /tmp/
10
- *.bundle
11
- *.so
12
- *.o
13
- *.a
14
- mkmf.log
15
- proteus*.gem
1
+ *gem
2
+ .DS_store
3
+ Gemfile.lock
4
+ pkg
5
+ tmp
data/CONTRIBUTING.md ADDED
@@ -0,0 +1,30 @@
1
+ We love pull requests from everyone. By participating in this project, you
2
+ agree to abide by the thoughtbot [code of conduct]. Here’s a quick guide:
3
+
4
+ [code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
5
+
6
+ 1. Fork the repository.
7
+ 2. Make your changes in a topic branch.
8
+ 3. Squash your commits into a single one (more on that
9
+ [here](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html)).
10
+ 4. Rebase against `origin/master`, push to your fork and submit a pull request.
11
+
12
+ At this point you’re waiting on us. We like to at least comment on, if not
13
+ accept, pull requests within three business days (and, typically, one business
14
+ day). We may suggest some changes or improvements or alternatives.
15
+
16
+ Some things that will increase the chance that your pull request is accepted:
17
+
18
+ * Write your code according to the [thoughtbot Style Guide][guide]
19
+ * Fix a bug, refactor code or expand an existing feature.
20
+ * Use the right syntax and naming conventions.
21
+ * Update parts of the documentation that are affected by your contribution.
22
+
23
+ [guide]: https://github.com/thoughtbot/guides/tree/master/style
24
+
25
+ **Git Commit Messages**
26
+
27
+ * Capitalize your commit messages.
28
+ * Start your message with a verb.
29
+ * Use present tense.
30
+ * Refer to the issue/PR number in your squashed commit message.
data/Gemfile CHANGED
@@ -1,4 +1,3 @@
1
1
  source 'https://rubygems.org'
2
2
 
3
- # Specify your gem's dependencies in proteus.gemspec
4
3
  gemspec
data/LICENSE.md ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright © 2014–2015 [thoughtbot, inc.](http://thoughtbot.com)
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the “Software”), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md CHANGED
@@ -1,47 +1,72 @@
1
1
  # Proteus
2
2
 
3
- ## About Proteus
4
- [Proteus](http://github.com/thoughtbot/proteus) is a collection of useful
5
- starter kits to help you prototype faster. They follow the
6
- [thoughtbot styleguide](https://github.com/thoughtbot/guides) and includes our
7
- favorite front end tools.
3
+ Proteus is a collection of useful starter kits to help you prototype
4
+ faster. They follow the [thoughtbot styleguide](https://github.com/thoughtbot/guides)
5
+ and includes our favorite front-end development tools.
8
6
 
9
7
  ## Kits
8
+
10
9
  * [Middleman](http://github.com/thoughtbot/proteus-middleman)
11
10
  * [Jekyll](http://github.com/thoughtbot/proteus-jekyll)
12
11
  * [Gulp](http://github.com/thoughtbot/proteus-gulp)
13
12
 
14
13
  ## Installation
15
14
 
16
- Just run this to install it:
15
+ 1. Install the Proteus gem using the [RubyGems](https://rubygems.org) package manager:
16
+
17
+ ```bash
18
+ gem install proteus-kits
19
+ ```
20
+
21
+ 2. Then kick off a new project with the kit you want to use (i.e. Middleman):
22
+
23
+ ```bash
24
+ proteus new middleman your-project-name
25
+ ```
26
+
27
+ ## Shortcuts
28
+
29
+ We’ve also included some handy shortcuts with Proteus:
17
30
 
18
- ```
19
- gem install proteus-kits
20
- ```
31
+ - Install dependencies and clear the Git remote:
21
32
 
22
- Then pick the project you want to start (i.e. Middleman)
23
- ```
24
- proteus new middleman your-project-name
25
- ```
33
+ ```bash
34
+ proteus setup
35
+ ```
26
36
 
27
- Shortcuts
28
- -------
37
+ - Start the kit-specific server (i.e. `bundle exec middleman server`):
29
38
 
30
- We have also included some handy shortcuts for your Proteus kit: `proteus setup`, `proteus server` and `proteus deploy`
39
+ ```bash
40
+ proteus server
41
+ ```
31
42
 
32
- Credits
33
- -------
43
+ - Run the kit-specific deploy (i.e. `middleman deploy`):
34
44
 
35
- ![thoughtbot](http://thoughtbot.com/logo.png)
45
+ ```bash
46
+ proteus deploy
47
+ ```
36
48
 
37
- This application is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
49
+ ## Contributing
50
+
51
+ If you'd like to contribute a feature or bugfix: Thanks! To make sure your
52
+ fix/feature has a high chance of being included, please read the following
53
+ guidelines:
54
+
55
+ 1. Fork the repository
56
+ 2. Make your changes
57
+ 3. Push your branch to your fork
58
+ 4. Post a [pull request](https://github.com/thoughtbot/proteus/compare).
59
+
60
+ Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more details on contributing and running test.
38
61
 
39
62
  Thank you to all [the contributors](https://github.com/thoughtbot/proteus-middleman/contributors)!
40
63
 
41
- License
42
- -------
64
+ ## Credits
65
+
66
+ [![thoughtbot](http://images.thoughtbot.com/bourbon/thoughtbot-logo.svg)](http://thoughtbot.com)
67
+
68
+ Proteus is maintained and funded by [thoughtbot, inc](http://thoughtbot.com). Thank you to all of [the contributors](https://github.com/thoughtbot/proteus-middleman/contributors)!
43
69
 
44
- The names and logos for thoughtbot are trademarks of thoughtbot, inc.
70
+ ## License
45
71
 
46
- Carnival is Copyright © 2014 thoughtbot, inc. It is free software, and may be
47
- redistributed under the terms specified in the LICENSE file.
72
+ Copyright © 2014–2015 [thoughtbot, inc](http://thoughtbot.com). Proteus is free software, and may be redistributed under the terms specified in the [license](LICENSE.md).
data/lib/proteus/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Proteus
2
- VERSION = "0.2"
2
+ VERSION = "0.3"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: proteus-kits
3
3
  version: !ruby/object:Gem::Version
4
- version: '0.2'
4
+ version: '0.3'
5
5
  platform: ruby
6
6
  authors:
7
7
  - Joshua Ogle
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2015-02-05 00:00:00.000000000 Z
11
+ date: 2015-08-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -75,9 +75,9 @@ extensions: []
75
75
  extra_rdoc_files: []
76
76
  files:
77
77
  - ".gitignore"
78
+ - CONTRIBUTING.md
78
79
  - Gemfile
79
- - Gemfile.lock
80
- - LICENSE.txt
80
+ - LICENSE.md
81
81
  - README.md
82
82
  - Rakefile
83
83
  - bin/proteus
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
107
107
  version: '0'
108
108
  requirements: []
109
109
  rubyforge_project:
110
- rubygems_version: 2.4.3
110
+ rubygems_version: 2.4.6
111
111
  signing_key:
112
112
  specification_version: 4
113
113
  summary: Starter kits to help you prototype faster
data/LICENSE.txt DELETED
@@ -1,22 +0,0 @@
1
- Copyright (c) 2014 Joshua Ogle
2
-
3
- MIT License
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining
6
- a copy of this software and associated documentation files (the
7
- "Software"), to deal in the Software without restriction, including
8
- without limitation the rights to use, copy, modify, merge, publish,
9
- distribute, sublicense, and/or sell copies of the Software, and to
10
- permit persons to whom the Software is furnished to do so, subject to
11
- the following conditions:
12
-
13
- The above copyright notice and this permission notice shall be
14
- included in all copies or substantial portions of the Software.
15
-
16
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
- LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
- OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
- WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.