Skip to content

Commit

Permalink
add waves assets
Browse files Browse the repository at this point in the history
  • Loading branch information
kremalicious committed Jun 12, 2020
1 parent 9349d07 commit 04d7883
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 31 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)

Expand Down
Binary file modified banner/banner-ocean-01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified banner/banner-ocean-01@2x.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified banner/banner-ocean-02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified banner/banner-ocean-02@2x.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 6 additions & 31 deletions github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
[![banner](repo-banner@2x.png)](https://oceanprotocol.com)
[![banner](https://raw.githubusercontent.com/oceanprotocol/art/master/github/repo-banner%402x.png)](https://oceanprotocol.com)

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

Expand All @@ -21,7 +21,7 @@ Always start a project's readme file like so, note how the banner is linked to o
```

Which will return:
[![banner](repo-banner@2x.png)](https://oceanprotocol.com)
[![banner](https://raw.githubusercontent.com/oceanprotocol/art/master/github/repo-banner%402x.png)](https://oceanprotocol.com)

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

Expand All @@ -30,28 +30,3 @@ Which will return:
[![npm](https://img.shields.io/npm/v/@oceanprotocol/art.svg)](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 changes: 11 additions & 0 deletions waves/README.md
Original file line number Diff line number Diff line change
@@ -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" />
Binary file added waves/waves.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions waves/waves.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 04d7883

Please sign in to comment.