🐬 Ocean Protocol's assets for community distribution
Switch branches/tags
Clone or download
ttmc Merge pull request #4 from oceanprotocol/feature/add-contributing-md-…
…file

Standardize contrib guidelines across public repos
Latest commit 8c5ed11 Nov 30, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
banner
github
jellyfish new banners, new mantaray, tweaked jellyfish Nov 22, 2018
logo add favicon Nov 22, 2018
mantaray new banners, new mantaray, tweaked jellyfish Nov 22, 2018
.gitignore
CONTRIBUTING.md Standardize contrib guidelines across public repos Nov 30, 2018
LICENSE document all assets Apr 23, 2018
README.md new banners, new mantaray, tweaked jellyfish Nov 22, 2018
package.json Release 2.1.0 Nov 22, 2018

README.md

art

art

🐬 Ocean Protocol's assets for community distribution.

npm

All assets in this repo can also be viewed and downloaded from oceanprotocol.com/art. You'll find a living styleguide there too.

Repository Contents

Typography

Our branding typefaces are Sharp Sans Medium/Bold in use as body text, and Sharp Sans Display No. 1 Bold for headings.

Those are commercial fonts and the license doesn't allow us to distribute them. Hence you won't find them in this repository. If you're a member of the Ocean Protocol team, ask a designer to hand you the font files.

If you only need them for use on the web, you can grab them from inside the private site repo's fonts folder.

Usage

It's encouraged to use this repo as a dependency within your projects to keep the assets in sync. The whole repo is published as a npm module so just run for installation:

npm i @oceanprotocol/art

Use as a submodule

From the root of your project folder execute the following to put the submodule under lib/art/:

git submodule add git@github.com:oceanprotocol/art.git lib/art

Then, from time to time, update the submodule to get latest upstream changes:

# go into submodule folder
cd ./lib/art
git checkout master
git pull
# get back to your project root
cd ../../

# or if you're a busy person, update all your submodules at once from the root of your project
git submodule foreach git pull origin master

Usage in JavaScript/React

Import the required assets into your project, which will return the file source path:

import Logo from './lib/art/logo/logo.svg'

<img src={Logo} />

But you usually want SVG assets to be inlined for full control over styling with CSS. To achieve that, you can incorporate svgr into your build process to import SVG assets as actual React components:

import Logo from './lib/art/logo/logo.svg'

<Logo className="logo" />

And then style away in CSS:

.logo {
    fill: #141414;
    stroke: none;
}

License

All assets are licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.