art/github
Matthias Kretschmann bddcc48e6f
new repo banner
2018-06-18 16:26:52 +02:00
..
README.md new repo banner 2018-06-18 16:26:52 +02:00
repo-banner.sketch new repo banner 2018-06-18 16:26:52 +02:00
repo-banner@2x.png new repo banner 2018-06-18 16:26:52 +02:00

README.md

Ocean Protocol GitHub

Use the repo banner to decorate an official Ocean Protocol repository's readme file.

Usage

  1. Open the Sketch file
  2. Modify the title on the right, and check the preview on the left
  3. Select the repo-banner Artboard and hit the Export repo-banner button in the very bottom right.
  4. You will receive a file repo-banner@2x.png which you can then use in Markdown, ideally linking the repo banner to oceanprotocol.com:
[![art](repo-banner@2x.png)](https://oceanprotocol.com)

Which will return:

art

Always start a project's readme file like so:

[![banner](repo-banner@2x.png)](https://oceanprotocol.com)

<h1 align="center">repo-name</h1>

> 🐳 Start with emoji, then add a tagline describing your project.

[![npm](https://img.shields.io/npm/v/@oceanprotocol/art.svg)](https://www.npmjs.com/package/@oceanprotocol/art)

Which will return: banner

repo-name

🐳 Start with emoji, then add a tagline describing your project.

npm