Skip to content

Commit e7f9881

Browse files
neocoticneocotic
committed
initial commit
0 parents  commit e7f9881

13 files changed

+219
-0
lines changed

‎.editorconfig

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
indent_style = space
7+
indent_size = 2
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true
10+
11+
[*.md]
12+
trim_trailing_whitespace = false

‎.eslintrc.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"extends": "notninja/es6",
3+
"env": {
4+
"node": true
5+
}
6+
}

‎.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text eol=lf

‎.gitignore

Whitespace-only changes.

‎.npmignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules/
2+
*.log

‎.travis.yml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
sudo: false
2+
language: node_js
3+
node_js:
4+
- "4"
5+
- "6"
6+
- "8"
7+
before_script:
8+
- npm install -g npm@latest
9+
script:
10+
- npm run ci

‎AUTHORS.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Authors ordered by first contribution
2+
3+
* Alasdair Mercer <[email protected]>

‎CONTRIBUTING.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing
2+
3+
If you have any questions about [Brander](https://github.com/NotNinja/brander) please feel free to
4+
[raise an issue](https://github.com/NotNinja/brander/issues/new).
5+
6+
Please [search existing issues](https://github.com/NotNinja/brander/issues) for the same feature and/or issue before
7+
raising a new issue. Commenting on an existing issue is usually preferred over raising duplicate issues.
8+
9+
Please ensure that all files conform to the coding standards, using the same coding style as the rest of the code base.
10+
This can easily be checked via command-line:
11+
12+
``` bash
13+
# install/update package dependencies
14+
$ npm install
15+
# run build & test suite
16+
$ npm run ci
17+
```
18+
19+
You must have at least [Node.js](https://nodejs.org) version 6 or newer and [npm](https://npmjs.com) version 5 or newer
20+
installed.
21+
22+
All pull requests should be made to the `develop` branch.
23+
24+
Don't forget to add your details to the list of [AUTHORS.md](https://github.com/NotNinja/brander/blob/master/AUTHORS.md)
25+
if you want your contribution to be recognized by others.

‎LICENSE.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright (C) 2017 Alasdair Mercer, !ninja
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
SOFTWARE.

‎README.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
888888b. 888
2+
888 "88b 888
3+
888 .88P 888
4+
8888888K. 888d888 8888b. 88888b. .d88888 .d88b. 888d888
5+
888 "Y88b 888P" "88b 888 "88b d88" 888 d8P Y8b 888P"
6+
888 888 888 .d888888 888 888 888 888 88888888 888
7+
888 d88P 888 888 888 888 888 Y88b 888 Y8b. 888
8+
8888888P" 888 "Y888888 888 888 "Y88888 "Y8888 888
9+
10+
[Brander](https://github.com/NotNinja/brander) is a tool for generating branding assets for your project or
11+
organisation.
12+
13+
[![Build Status](https://img.shields.io/travis/NotNinja/brander/develop.svg?style=flat-square)](https://travis-ci.org/NotNinja/brander)
14+
[![Dependency Status](https://img.shields.io/david/NotNinja/brander.svg?style=flat-square)](https://david-dm.org/NotNinja/brander)
15+
[![Dev Dependency Status](https://img.shields.io/david/dev/NotNinja/brander.svg?style=flat-square)](https://david-dm.org/NotNinja/brander?type=dev)
16+
[![License](https://img.shields.io/npm/l/brander.svg?style=flat-square)](https://github.com/NotNinja/brander/blob/master/LICENSE.md)
17+
[![Release](https://img.shields.io/npm/v/brander.svg?style=flat-square)](https://www.npmjs.com/package/brander)
18+
19+
* [Install](#install)
20+
* [API](#api)
21+
* [Bugs](#bugs)
22+
* [Contributors](#contributors)
23+
* [License](#license)
24+
25+
## Install
26+
27+
Install using [npm](https://www.npmjs.com):
28+
29+
``` bash
30+
$ npm install --save brander
31+
```
32+
33+
## API
34+
35+
TODO: Complete
36+
37+
## Bugs
38+
39+
If you have any problems with Brander or would like to see changes currently in development you can do so
40+
[here](https://github.com/NotNinja/brander/issues).
41+
42+
43+
## Contributors
44+
45+
If you want to contribute, you're a legend! Information on how you can do so can be found in
46+
[CONTRIBUTING.md](https://github.com/NotNinja/brander/blob/master/CONTRIBUTING.md). We want your suggestions and pull
47+
requests!
48+
49+
A list of Brander contributors can be found in [AUTHORS.md](https://github.com/NotNinja/brander/blob/master/AUTHORS.md).
50+
51+
## License
52+
53+
See [LICENSE.md](https://github.com/NotNinja/brander/raw/master/LICENSE.md) for more information on our MIT license.
54+
55+
[![Copyright !ninja](https://cdn.rawgit.com/NotNinja/branding/master/assets/copyright/base/not-ninja-copyright-186x25.png)](https://not.ninja)

‎bin/brander

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
#!/usr/bin/env node
2+
3+
/*
4+
* Copyright (C) 2017 Alasdair Mercer, !ninja
5+
*
6+
* Permission is hereby granted, free of charge, to any person obtaining a copy
7+
* of this software and associated documentation files (the "Software"), to deal
8+
* in the Software without restriction, including without limitation the rights
9+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
* copies of the Software, and to permit persons to whom the Software is
11+
* furnished to do so, subject to the following conditions:
12+
*
13+
* The above copyright notice and this permission notice shall be included in all
14+
* copies or substantial portions of the Software.
15+
*
16+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22+
* SOFTWARE.
23+
*/
24+
25+
'use strict';
26+
27+
// TODO: Complete

‎package.json

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"name": "brander",
3+
"version": "0.1.0",
4+
"description": "Tool for generating branding assets",
5+
"homepage": "https://github.com/NotNinja/brander",
6+
"bugs": {
7+
"url": "https://github.com/NotNinja/brander/issues"
8+
},
9+
"author": {
10+
"name": "Alasdair Mercer",
11+
"email": "[email protected]",
12+
"url": "https://not.ninja"
13+
},
14+
"license": "MIT",
15+
"keywords": [
16+
"brand",
17+
"tool"
18+
],
19+
"repository": {
20+
"type": "git",
21+
"url": "https://github.com/NotNinja/brander.git"
22+
},
23+
"bin": {
24+
"brander": "bin/brander"
25+
},
26+
"main": "src/brander.js",
27+
"scripts": {
28+
"ci": "npm run test",
29+
"test": "eslint \"src/**/*.js\""
30+
},
31+
"engines": {
32+
"node": ">=6"
33+
},
34+
}

‎src/brander.js

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/*
2+
* Copyright (C) 2017 Alasdair Mercer, !ninja
3+
*
4+
* Permission is hereby granted, free of charge, to any person obtaining a copy
5+
* of this software and associated documentation files (the "Software"), to deal
6+
* in the Software without restriction, including without limitation the rights
7+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8+
* copies of the Software, and to permit persons to whom the Software is
9+
* furnished to do so, subject to the following conditions:
10+
*
11+
* The above copyright notice and this permission notice shall be included in all
12+
* copies or substantial portions of the Software.
13+
*
14+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20+
* SOFTWARE.
21+
*/
22+
23+
'use strict';
24+
25+
// TODO: Complete

0 commit comments

Comments
 (0)