add waves assets
@ -19,6 +19,7 @@ All assets in this repo can also be viewed and downloaded from [oceanprotocol.co
|
||||
|
||||
- [Logo](logo/)
|
||||
- [Banner](banner/)
|
||||
- [Waves](waves/)
|
||||
- [Creatures](creatures/)
|
||||
- [GitHub](github/)
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 79 KiB After Width: | Height: | Size: 33 KiB |
|
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 96 KiB After Width: | Height: | Size: 34 KiB |
@ -2,16 +2,16 @@
|
||||
|
||||
Use the repo banner to decorate an official Ocean Protocol repository's readme file and follow those points to open source a repo:
|
||||
|
||||
* add repo banner
|
||||
* add LICENSE file, add license block at end of readme
|
||||
* add badges, like a Travis badge linking to the project on Travis. If repo has been published to package registries, add their badge too. You can use shields.io to get them all from one place
|
||||
- add repo banner
|
||||
- add LICENSE file, add license block at end of readme
|
||||
- add badges, like a Travis badge linking to the project on Travis. If repo has been published to package registries, add their badge too. You can use shields.io to get them all from one place
|
||||
|
||||
## Basic readme structure
|
||||
|
||||
Always start a project's readme file like so, note how the banner is linked to our landing page:
|
||||
Always start a project's readme file like so, note how the banner is linked to our landing page and sourced remotely from the `art` repo:
|
||||
|
||||
```md
|
||||
[](https://oceanprotocol.com)
|
||||
[](https://oceanprotocol.com)
|
||||
|
||||
<h1 align="center">repo-name</h1>
|
||||
|
||||
@ -21,7 +21,7 @@ Always start a project's readme file like so, note how the banner is linked to o
|
||||
```
|
||||
|
||||
Which will return:
|
||||
[](https://oceanprotocol.com)
|
||||
[](https://oceanprotocol.com)
|
||||
|
||||
<h1 align="center">repo-name</h1>
|
||||
|
||||
@ -30,28 +30,3 @@ Which will return:
|
||||
[](https://www.npmjs.com/package/@oceanprotocol/art)
|
||||
|
||||
The tagline in there should always be the same as the repo description on GitHub. With tagline, try to summarize what a user can do with the repo. And most importantly: pick an emoji for your project and put it in front of the tagline.
|
||||
|
||||
### Table of Contents
|
||||
|
||||
As soon as you have more than 3 sections in your readme, add a Table of Contents above all content. [toctoc](https://github.com/n1k0/toctoc) is your friend:
|
||||
|
||||
1. add this block to yopur readme after the project intro:
|
||||
|
||||
```md
|
||||
## Table of Contents
|
||||
---
|
||||
```
|
||||
|
||||
2. run toctoc:
|
||||
|
||||
```bash
|
||||
toctoc README.md -w
|
||||
```
|
||||
|
||||
And make sure to update TOC as you update your readme too.
|
||||
|
||||
### Usage
|
||||
|
||||
Then immediately start with usage instructions. Goal should be for any dev to be able to get the project running within 1 min. So make it nicely copy/pasteable, don't just say "clone the repo and install dependencies". Write it out, e.g. see in [site repo](https://github.com/oceanprotocol/site/blob/master/README.md#development)
|
||||
|
||||
Those first usage instructions should be as short as possible so this implies you have to setup everything in your project to make that possible. E.g. for front end projects everything should be handled behind a simple npm start script.
|
||||
|
||||
11
waves/README.md
Normal file
@ -0,0 +1,11 @@
|
||||
# The Ocean Protocol Waves
|
||||
|
||||
Created and designed entirely in code as SVG paths, animated with CSS by [D3.js](https://d3js.org).
|
||||
|
||||
The original wave used on our website can be found on CodePen, which you can use to create your own screenshots of the waves in other variations.
|
||||
|
||||
- [CodePen: Ocean Protocol Waves](https://codepen.io/kremalicious/pen/vYLNWXe)
|
||||
|
||||
The assets in this repo are a recreation of those code-generated waves.
|
||||
|
||||
<img src="waves.svg" />
|
||||
BIN
waves/waves.png
Normal file
|
After Width: | Height: | Size: 32 KiB |
1
waves/waves.svg
Normal file
@ -0,0 +1 @@
|
||||
<svg fill="none" height="352" viewBox="0 0 2050 352" width="2050" xmlns="http://www.w3.org/2000/svg"><g stroke-width="2"><path d="m2049 8.59412c-22.5-6.49994-88-14.49994-182.5 2.99998-134.5 50-164 64.5-257 67.9999-102.5 14.5001-195-25.4999-302-14.5-174.74 47.081-196 150.371-313.5 147s-206-103.465-331-92.5c-85.5 7.5-196 206.5-293.5 206.5-77.274 0-118-26-170-52l-198.5-107.5" stroke="#e2e2e2"/><path d="m1950 2.59412c-19-.00015-77.5 3-113 12.99988-102 42.0001-191 60.9998-283.5 74.9999-77.81 11.7761-233.5-38.8779-302-14.5-170.5 60.6781-196 150.3711-313.5 147.0001s-206-103.465-331-92.5c-85.5 7.5-196 206.5-293.5 206.5-77.274 0-118-26-170-52l-129-77" stroke="#8b98a9"/><path d="m1970 1.09412c-55.5 4.5-88.56 0-177 26.49998-138.5 41.5-206 62.5891-297.5 68.9999-78.5 5.5-233.5-38.8779-302-14.5-170.5 60.678-196 150.371-313.5 147s-206-103.465-331-92.5c-85.5 7.5-196 206.5-293.5 206.5-77.274 0-118-26-170-52l-70-36" stroke="#e000cf"/><path d="m14.5 297.094c52 26 96.226 53.5 173.5 53.5 97.5 0 208-199 293.5-206.5 125-10.965 213.5 89.129 331 92.5s143-86.322 313.5-147c68.5-24.3779 223.5 20 302 14.5 91.5-6.4108 159-27.4999 297.5-68.9999 88.44-26.49998 168-28.49998 223.5-32.99998" stroke="#ff4092"/></g></svg>
|
||||
|
After Width: | Height: | Size: 1.2 KiB |