https://github.com/neocotic/brander

A tool for generating branding assets and documentation
https://github.com/neocotic/brander

assets brand branding documentation javascript nodejs

Last synced: about 1 year ago
JSON representation

A tool for generating branding assets and documentation

• Host: GitHub
• URL: https://github.com/neocotic/brander
• Owner: neocotic
• License: mit
• Created: 2017-09-19T10:54:54.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2023-08-29T10:05:44.000Z (almost 3 years ago)
• Last Synced: 2025-04-10T08:46:29.751Z (about 1 year ago)
• Topics: assets, brand, branding, documentation, javascript, nodejs
• Language: JavaScript
• Homepage:
• Size: 651 KB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Brander

[![Build Status](https://img.shields.io/github/actions/workflow/status/neocotic/brander/ci.yml?style=flat-square)](https://github.com/neocotic/brander/actions/workflows/ci.yml)

[![Coverage](https://img.shields.io/codecov/c/github/neocotic/brander/develop.svg?style=flat-square)](https://codecov.io/gh/neocotic/brander)

[![License](https://img.shields.io/npm/l/brander.svg?style=flat-square)](https://github.com/neocotic/brander/blob/main/LICENSE.md)

[![Release](https://img.shields.io/npm/v/brander.svg?style=flat-square)](https://npmjs.com/package/brander)

[Brander](https://github.com/neocotic/brander) is a tool for generating branding assets and documentation for your

project or organisation.

* [Install](#install)

* [Usage](#usage)

* [Bugs](#bugs)

* [Contributors](#contributors)

* [License](#license)

## Install

Install using [npm](https://npmjs.com):

``` bash

$ npm install --save brander

```

Alternatively, if you're wanting to use `brander` command, you'll probably prefer to install it globally:

``` bash

$ npm install --global brander

```

You'll need to have at least [Node.js](https://nodejs.org) 18 or newer.

## Usage

You can find all the documentation required to configure and use Brander to generate assets and docs below:

https://github.com/neocotic/brander/wiki

## Bugs

If you have any problems with Brander or would like to see changes currently in development you can do so

[here](https://github.com/neocotic/brander/issues).

## Contributors

If you want to contribute, you're a legend! Information on how you can do so can be found in

[CONTRIBUTING.md](https://github.com/neocotic/brander/blob/main/CONTRIBUTING.md). We want your suggestions and pull

requests!

A list of Brander contributors can be found in [AUTHORS.md](https://github.com/neocotic/brander/blob/main/AUTHORS.md).

## License

Copyright © 2023 neocotic

See [LICENSE.md](https://github.com/neocotic/brander/raw/main/LICENSE.md) for more information on our MIT license.