atomaka
/
puppet-whatpulse
1
0
Fork 0
Code Releases Activity

Update README.

This commit is contained in:
Andrew Tomaka 2013-10-13 21:51:21 -04:00
parent cc321681d4
commit dedd47f491
1 changed files with 7 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@ -1,64 +1,18 @@
# Using this Template
# Whatpulse Puppet Module for Boxen
Bootstrap it:
[![Build Status](https://travis-ci.org/atomaka/puppet-whatpulse.png?branch=master)](https://travis-ci.org/atomaka/puppet-whatpulse)
```
mkdir -p ~/src/boxen/puppet-mynewmodule
cd ~/src/boxen/puppet-mynewmodule
git init .
git remote add template https://github.com/boxen/puppet-template.git
git fetch template
git checkout -b master template/master
```
Now we're ready to make it our own!
```
script/cibuild
.bundle/binstubs/rspec-puppet-init
```
Now you'll need to edit `manifests/init.pp` and `spec/classes/template_spec.rb`
for your module.
If your module has other dependencies, be sure to update
`spec/fixtures/Puppetfile`.
From then on, you can use `script/cibuild` to run the tests.
When you're ready to push:
```
git create githubusername/puppet-mynewmodule
git push origin master
```
The rest of the README as follows can be used as a template for your module's README.
# Template Puppet Module for Boxen
An example of how we write Puppet modules for Boxen. Replace this
paragraph with a short explanation of what the heck makes your module
useful.
A great module has a working travis build
[![Build Status](https://travis-ci.org/boxen/puppet-template.png?branch=master)](https://travis-ci.org/boxen/puppet-template)
Install [Whatpulse](http://www.whatpulse.org/), an application for tracking your computing habits.
## Usage
```puppet
boxen::example { 'best example ever':
salutation => 'fam'
}
include whatpulse
```
## Required Puppet Modules
* `boxen`
* `anything-else`
* boxen
## Development
Set `GITHUB_API_TOKEN` in your shell with a [Github oAuth Token](https://help.github.com/articles/creating-an-oauth-token-for-command-line-use) to raise your API rate limit. You can get some work done without it, but you're less likely to encounter errors like `Unable to find module 'boxen/puppet-boxen' on https://github.com`.
Then write some code. Run `script/cibuild` to test it. Check the `script`
directory for other useful tools.
## Developing
Write code. Run ```script/cbuild```.