mirror of
https://github.com/oceanprotocol/art
synced 2024-11-15 01:34:54 +01:00
41 lines
1.2 KiB
Markdown
41 lines
1.2 KiB
Markdown
# 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:
|
|
|
|
```md
|
|
[](https://oceanprotocol.com)
|
|
```
|
|
|
|
Which will return:
|
|
|
|
[](https://oceanprotocol.com)
|
|
|
|
Always start a project's readme file like so:
|
|
|
|
```md
|
|
[](https://oceanprotocol.com)
|
|
|
|
<h1 align="center">repo-name</h1>
|
|
|
|
> 🐳 Start with emoji, then add a tagline describing your project.
|
|
|
|
[](https://www.npmjs.com/package/@oceanprotocol/art)
|
|
````
|
|
|
|
Which will return:
|
|
[](https://oceanprotocol.com)
|
|
|
|
<h1 align="center">repo-name</h1>
|
|
|
|
> 🐳 Start with emoji, then add a tagline describing your project.
|
|
|
|
[](https://www.npmjs.com/package/@oceanprotocol/art)
|
|
|