888 888b    888 888 888b    888        8888 8888b
888 8888b   888 888 8888b   888        8888 88888b
888 88888b  888 888 88888b  888         888 888Y88b
888 888Y88b 888 888 888Y88b 888         888 888 Y88b
888 888 Y88b888 888 888 Y88b888         888 888  Y88b
    888  Y88888 888 888  Y88888 888     888 888   Y88b
8"8 888   Y8888 888 888   Y8888 88888888888 888    Y88b
888 888    Y888 888 888    Y888 88888888888 888     Y88b

This repository contains branding assets and guidelines for !ninja.

1. Guidelines
   1. Fonts
2. Colors
   1. Palette
3. Assets
   1. Banners
   2. Copyright
   3. Logos
   4. Tiles
   5. Social

All assets are owned by !ninja and intended for use by !ninja, however, we are an open organization so if you wish to use our assets, simply ask us for permission to do so, detailing who/what/when/where/why you intend to use them.

The best way to get in touch with us is via email or on slack.

The assets and documentation within this repository are generated using Brander based on our .branderrc.json configuration file.

To get started, first clone the repository:

$ git clone https://github.com/NotNinja/branding.git
$ cd branding

Then install all of the necessary dependencies:

branding$ npm install

Now you can easily generate all assets and documentation after making whatever changes you want to the configuration file or asset sources:

branding$ npm start

If successful, it should end with "Done!".