Skip to content

Commit

Permalink
v1.0.0. Initial stable release.
Browse files Browse the repository at this point in the history
- Initial stable release
- Readme and Package files are now extension independent
- Readme sections are now outputted in HTML instead of Markdown to be
more universal
- Support SPDX licenses
	- Implements [#72](#72),
[#66](#66)
	- Fixes [#65](#65)
- Uses new [bevry/badges](https://github.com/bevry/badges) package for
badge rendering
	- Implements [#67](#67),
[#55](#55),
[#25](#25),
[#10](#10)
- Uses new [bevry/fellow](https://github.com/bevry/fellow) package for
people handling
	- Implements [#37](#37),
[#11](#11)
- Newline no longer required at start of readme file
	- Fixes [#53](#53)
- Moved from CoffeeScript to ES6+
	- Fixes [#20](#20)
  • Loading branch information
balupton committed Sep 16, 2015
1 parent 85ff617 commit 2538b8c
Show file tree
Hide file tree
Showing 13 changed files with 233 additions and 139 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,4 +137,4 @@ To publish your changes as the project owner:
npm run-script release
```
> A prompt will occur asking you for a git tag annotation, enter the changelog entry that we created earlier, save and exit the prompt.
> A prompt will occur asking you for a git tag annotation, enter the changelog entry that we created earlier, save and exit the prompt.
23 changes: 22 additions & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,23 @@
<!-- LICENSEFILE/ -->

<!-- LICENSEFILE -->
<h1>License</h1>

Unless stated otherwise all works are:

<ul><li>Copyright &copy; 2013+ <a href="http://bevry.me">Bevry Pty Ltd</a></li></ul>

and licensed under:

<ul><li><a href="http://spdx.org/licenses/MIT.html">MIT License</a></li></ul>

<h2>MIT License</h2>

<pre>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
</pre>

<!-- /LICENSEFILE -->
85 changes: 46 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@
<!-- TITLE/ -->

# Projectz
<h1>Projectz</h1>

<!-- /TITLE -->


<!-- BADGES/ -->

[![Build Status](https://img.shields.io/travis/bevry/projectz/master.svg)](http://travis-ci.org/bevry/projectz "Check this project's build status on TravisCI")
[![NPM version](https://img.shields.io/npm/v/projectz.svg)](https://npmjs.org/package/projectz "View this project on NPM")
[![NPM downloads](https://img.shields.io/npm/dm/projectz.svg)](https://npmjs.org/package/projectz "View this project on NPM")
[![Dependency Status](https://img.shields.io/david/bevry/projectz.svg)](https://david-dm.org/bevry/projectz)
[![Dev Dependency Status](https://img.shields.io/david/dev/bevry/projectz.svg)](https://david-dm.org/bevry/projectz#info=devDependencies)<br/>
[![Gratipay donate button](https://img.shields.io/gratipay/bevry.svg)](https://www.gratipay.com/bevry/ "Donate weekly to this project using Gratipay")
[![Flattr donate button](https://img.shields.io/badge/flattr-donate-yellow.svg)](http://flattr.com/thing/344188/balupton-on-Flattr "Donate monthly to this project using Flattr")
[![PayPal donate button](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QB8GQPZAH84N6 "Donate once-off to this project using Paypal")
[![BitCoin donate button](https://img.shields.io/badge/bitcoin-donate-yellow.svg)](https://coinbase.com/checkouts/9ef59f5479eec1d97d63382c9ebcb93a "Donate once-off to this project using BitCoin")
[![Wishlist browse button](https://img.shields.io/badge/wishlist-donate-yellow.svg)](http://amzn.com/w/2F8TXKSNAFG4V "Buy an item on our wishlist for us")
<span class="badge-travisci"><a href="http://travis-ci.org/bevry/projectz" title="Check this project's build status on TravisCI"><img src="https://img.shields.io/travis/bevry/projectz/master.svg" alt="Travis CI Build Status" /></a></span>
<span class="badge-npmversion"><a href="https://npmjs.org/package/projectz" title="View this project on NPM"><img src="https://img.shields.io/npm/v/projectz.svg" alt="NPM version" /></a></span>
<span class="badge-npmdownloads"><a href="https://npmjs.org/package/projectz" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/projectz.svg" alt="NPM downloads" /></a></span>
<span class="badge-daviddm"><a href="https://david-dm.org/bevry/projectz" title="View the status of this project's dependencies on DavidDM"><img src="https://img.shields.io/david/bevry/projectz.svg" alt="Dependency Status" /></a></span>
<span class="badge-daviddmdev"><a href="https://david-dm.org/bevry/projectz#info=devDependencies" title="View the status of this project's development dependencies on DavidDM"><img src="https://img.shields.io/david/dev/bevry/projectz.svg" alt="Dev Dependency Status" /></a></span>
<br class="badge-separator" />
<span class="badge-slackin"><a href="https://slack.bevry.me" title="Join this project's slack community"><img src="https://slack.bevry.me/badge.svg" alt="Slack community badge" /></a></span>
<span class="badge-patreon"><a href="http://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
<span class="badge-gratipay"><a href="https://www.gratipay.com/bevry" title="Donate weekly to this project using Gratipay"><img src="https://img.shields.io/badge/gratipay-donate-yellow.svg" alt="Gratipay donate button" /></a></span>
<span class="badge-flattr"><a href="http://flattr.com/thing/344188/balupton-on-Flattr" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
<span class="badge-paypal"><a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&amp;hosted_button_id=QB8GQPZAH84N6" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
<span class="badge-bitcoin"><a href="https://bevry.me/bitcoin" title="Donate once-off to this project using Bitcoin"><img src="https://img.shields.io/badge/bitcoin-donate-yellow.svg" alt="Bitcoin donate button" /></a></span>
<span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>

<!-- /BADGES -->

Expand Down Expand Up @@ -57,11 +60,11 @@ Here's some of the things it can do:

<!-- INSTALL/ -->

## Install
<h2>Install</h2>

### [NPM](http://npmjs.org/)
- Use: `require('projectz')`
- Install: `npm install --save projectz`
<a href="https://npmjs.com" title="npm is a package manager for javascript"><h3>NPM</h3></a><ul>
<li>Install: <code>npm install --save projectz</code></li>
<li>Use: <code>require('projectz')</code></li></ul>

<!-- /INSTALL -->

Expand Down Expand Up @@ -228,66 +231,70 @@ As an example, here is a a basic `README.md` file:

<!-- HISTORY/ -->

## History
[Discover the change history by heading on over to the `HISTORY.md` file.](https://github.com/bevry/projectz/blob/master/HISTORY.md#files)
<h2>History</h2>

<a href="https://github.com/bevry/projectz/blob/master/HISTORY.md#files">Discover the release history by heading on over to the <code>HISTORY.md</code> file.</a>

<!-- /HISTORY -->


<!-- CONTRIBUTE/ -->

## Contribute
<h2>Contribute</h2>

[Discover how you can contribute by heading on over to the `CONTRIBUTING.md` file.](https://github.com/bevry/projectz/blob/master/CONTRIBUTING.md#files)
<a href="https://github.com/bevry/projectz/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>

<!-- /CONTRIBUTE -->


<!-- BACKERS/ -->

## Backers
<h2>Backers</h2>

### Maintainers
<h3>Maintainers</h3>

These amazing people are maintaining this project:

- Benjamin Lupton <b@lupton.cc> (https://github.com/balupton)
- Rob Loach <robloach@gmail.com> (https://github.com/RobLoach)
<ul><li><a href="http://balupton.com">Benjamin Lupton</a> — <a href="https://github.com/bevry/projectz/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository bevry/projectz">view contributions</a></li>
<li><a href="http://robloach.net">Rob Loach</a> — <a href="https://github.com/bevry/projectz/commits?author=RobLoach" title="View the GitHub contributions of Rob Loach on repository bevry/projectz">view contributions</a></li></ul>

### Sponsors
<h3>Sponsors</h3>

No sponsors yet! Will you be the first?

[![Gratipay donate button](https://img.shields.io/gratipay/bevry.svg)](https://www.gratipay.com/bevry/ "Donate weekly to this project using Gratipay")
[![Flattr donate button](https://img.shields.io/badge/flattr-donate-yellow.svg)](http://flattr.com/thing/344188/balupton-on-Flattr "Donate monthly to this project using Flattr")
[![PayPal donate button](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QB8GQPZAH84N6 "Donate once-off to this project using Paypal")
[![BitCoin donate button](https://img.shields.io/badge/bitcoin-donate-yellow.svg)](https://coinbase.com/checkouts/9ef59f5479eec1d97d63382c9ebcb93a "Donate once-off to this project using BitCoin")
[![Wishlist browse button](https://img.shields.io/badge/wishlist-donate-yellow.svg)](http://amzn.com/w/2F8TXKSNAFG4V "Buy an item on our wishlist for us")
<span class="badge-patreon"><a href="http://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
<span class="badge-gratipay"><a href="https://www.gratipay.com/bevry" title="Donate weekly to this project using Gratipay"><img src="https://img.shields.io/badge/gratipay-donate-yellow.svg" alt="Gratipay donate button" /></a></span>
<span class="badge-flattr"><a href="http://flattr.com/thing/344188/balupton-on-Flattr" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
<span class="badge-paypal"><a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&amp;hosted_button_id=QB8GQPZAH84N6" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
<span class="badge-bitcoin"><a href="https://bevry.me/bitcoin" title="Donate once-off to this project using Bitcoin"><img src="https://img.shields.io/badge/bitcoin-donate-yellow.svg" alt="Bitcoin donate button" /></a></span>
<span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>

### Contributors
<h3>Contributors</h3>

These amazing people have contributed code to this project:

- [Benjamin Lupton](https://github.com/balupton) <b@lupton.cc>[view contributions](https://github.com/bevry/projectz/commits?author=balupton)
- [pflannery](https://github.com/pflannery)[view contributions](https://github.com/bevry/projectz/commits?author=pflannery)
- [Rob Loach](https://github.com/RobLoach) <robloach@gmail.com>[view contributions](https://github.com/bevry/projectz/commits?author=RobLoach)
- [Zearin](https://github.com/Zearin)[view contributions](https://github.com/bevry/projectz/commits?author=Zearin)
<ul><li><a href="http://balupton.com">Benjamin Lupton</a> — <a href="https://github.com/bevry/projectz/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository bevry/projectz">view contributions</a></li>
<li><a href="https://github.com/pflannery">Peter Flannery</a> — <a href="https://github.com/bevry/projectz/commits?author=pflannery" title="View the GitHub contributions of Peter Flannery on repository bevry/projectz">view contributions</a></li>
<li><a href="http://robloach.net">Rob Loach</a> — <a href="https://github.com/bevry/projectz/commits?author=RobLoach" title="View the GitHub contributions of Rob Loach on repository bevry/projectz">view contributions</a></li>
<li><a href="https://github.com/Zearin">Zearin</a> — <a href="https://github.com/bevry/projectz/commits?author=Zearin" title="View the GitHub contributions of Zearin on repository bevry/projectz">view contributions</a></li>
<li><a href="https://github.com/vsopvsop">vsopvsop</a> — <a href="https://github.com/bevry/projectz/commits?author=vsopvsop" title="View the GitHub contributions of vsopvsop on repository bevry/projectz">view contributions</a></li>
<li><a href="http://mightyi.am">Shahar Or</a> — <a href="https://github.com/bevry/projectz/commits?author=mightyiam" title="View the GitHub contributions of Shahar Or on repository bevry/projectz">view contributions</a></li></ul>

[Become a contributor!](https://github.com/bevry/projectz/blob/master/CONTRIBUTING.md#files)
<a href="https://github.com/bevry/projectz/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>

<!-- /BACKERS -->


<!-- LICENSE/ -->

## License
<h2>License</h2>

Unless stated otherwise all works are:

- Copyright &copy; 2013+ Bevry Pty Ltd <us@bevry.me> (http://bevry.me)
<ul><li>Copyright &copy; 2013+ <a href="http://bevry.me">Bevry Pty Ltd</a></li></ul>

and licensed under:

- The incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT License](http://opensource.org/licenses/mit-license.php)
<ul><li><a href="http://spdx.org/licenses/MIT.html">MIT License</a></li></ul>

<!-- /LICENSE -->
<!-- /LICENSE -->
4 changes: 2 additions & 2 deletions esnext/lib/backer-util.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export function getContributorsText (opts) {
// ignore
result +=
'No contributors yet! Will you be the first?' +
`\n${getContributeLink(opts, {optional: true})}`
`\n\n${getContributeLink(opts, {optional: true})}`
}
else {
result +=
Expand Down Expand Up @@ -128,7 +128,7 @@ export function getContributeSection (opts) {
const result = [
'<h2>Contribute</h2>',
'',
getContributeLink(opts)
getContributeLink(opts, {})
].join('\n')

// Return
Expand Down
27 changes: 17 additions & 10 deletions esnext/lib/install-util.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,55 +11,62 @@ export function getInstallInstructions (opts) {

else {
// Node
if ( opts.packages.package ) {
if ( opts.filenamesForPackageFiles.package ) {
const npmLink = projectzUtil.getLink({text: '<h3>NPM</h3>', url: 'https://npmjs.com', title: 'npm is a package manager for javascript'})

if ( opts.preferGlobal ) {
const commands = '<code>' + Object.keys(opts.bin || {}).join('</code> <code>') + '</code>'

// Global NPM
parts.push([
`<h3>${projectzUtil.getLink({text: 'NPM', url: 'https://npmjs.com', title: 'npm is a package manager for javascript'})}</h3><ul>`,
`${npmLink}<ul>`,
`<li>Install: <code>npm install --global ${opts.name}</code></li>`,
`<li>Use: ${commands}</li></ul>`
].join('\n'))
}
else {
// Local NPM
parts.push([
`<h3>${projectzUtil.getLink({text: 'NPM', url: 'https://npmjs.com', title: 'npm is a package manager for javascript'})}</h3><ul>`,
`${npmLink}<ul>`,
`<li>Install: <code>npm install --save ${opts.name}</code></li>`,
`<li>Use: <code>require('${opts.name}')</code></li></ul>`
].join('\n'))
}

// Browser
if ( opts.browsers ) {
const browserifyLink = projectzUtil.getLink({text: '<h3>Browserify</h3>', url: 'http://browserify.org', title: "Browserify lets you require('modules') in the browser by bundling up all of your dependencies"})
parts.push([
`<h3>${projectzUtil.getLink({text: 'Browserify', url: 'http://browserify.org', title: "Browserify lets you require('modules') in the browser by bundling up all of your dependencies"})}</h3><ul>`,
`${browserifyLink}<ul>`,
`<li>Install: <code>npm install --save ${opts.name}</code></li>`,
`<li>Use: <code>require('${opts.name}')</code></li>`
`<li>Use: <code>require('${opts.name}')</code></li>`,
`<li>CDN URL: <code>//wzrd.in/bundle/${opts.name}@${opts.version}</code></li></ul>`
].join('\n'))

const enderLink = projectzUtil.getLink({text: '<h3>Ender</h3>', url: 'http://enderjs.com', title: 'Ender is a full featured package manager for your browser'})
parts.push([
`<h3>${projectzUtil.getLink({text: 'Ender', url: 'http://enderjs.com', title: 'Ender is a full featured package manager for your browser'})}</h3><ul>`,
`${enderLink}<ul>`,
`<li>Install: <code>ender add ${opts.name}</code></li>`,
`<li>Use: <code>require('${opts.name}')</code></li></ul>`
].join('\n'))
}
}

// Component
if ( opts.packages.component ) {
if ( opts.filenamesForPackageFiles.component ) {
const componentLink = projectzUtil.getLink({text: '<h3>Component</h3>', url: 'https://github.com/component/component', title: 'Frontend package manager and build tool for modular web applications'})
parts.push([
`<h3>${projectzUtil.getLink({text: 'Component', url: 'https://github.com/component/component', title: 'Frontend package manager and build tool for modular web applications'})}</h3><ul>`,
`${componentLink}<ul>`,
`<li>Install: <code>component install ${opts.name}</code></li>`,
`<li>Use: <code>require('${opts.name}')</code></li></ul>`
].join('\n'))
}

// Bower
if ( opts.packages.bower ) {
if ( opts.filenamesForPackageFiles.bower ) {
const bowerLink = projectzUtil.getLink({text: '<h3>Bower</h3>', url: 'http://bower.io', title: 'A package manager for the web'})
parts.push([
`<h3>${projectzUtil.getLink({text: 'Bower', url: 'http://bower.io', title: 'A package manager for the web'})}</h3><ul>`,
`${bowerLink}<ul>`,
`<li>Install: <code>bower install ${opts.name}</code></li>`,
`<li>Use: <code>require('${opts.name}')</code></li></ul>`
].join('\n'))
Expand Down
5 changes: 4 additions & 1 deletion esnext/lib/projectz-util.js
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,10 @@ export function getPeopleTextArray (people, opts = {}) {
else {
let textArray = []
people.forEach(function (person) {
if ( !person.name || person.name === 'null' ) throw new Error('For some reason the person doesn\'t have a name')
if ( !person.name || person.name === 'null' ) {
console.error(person)
throw new Error('For some reason the person doesn\'t have a name')
}
const text = getPersonText(person, opts)
if ( text ) textArray.push(text)
})
Expand Down
Loading

0 comments on commit 2538b8c

Please sign in to comment.