art/README.md

57 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

2018-04-18 12:32:46 +02:00
[![art](github/repo-banner@2x.png)](https://oceanprotocol.com)
2018-04-17 14:29:15 +02:00
2018-06-18 16:26:52 +02:00
<h1 align="center">art</h1>
2020-06-11 15:09:07 +02:00
> 🐬 Ocean Protocol's brand assets for community distribution.
2018-04-17 14:29:15 +02:00
2018-06-18 16:10:26 +02:00
[![npm](https://img.shields.io/npm/v/@oceanprotocol/art.svg)](https://www.npmjs.com/package/@oceanprotocol/art)
2018-06-04 17:16:22 +02:00
2020-06-11 15:09:07 +02:00
All assets in this repo can also be viewed and downloaded from [oceanprotocol.com/art](https://oceanprotocol.com/art). You'll find a living style guide there too.
2018-04-18 12:32:46 +02:00
2020-06-11 15:09:07 +02:00
- [Brand Assets](#brand-assets)
2018-12-21 15:13:39 +01:00
- [Usage](#usage)
2020-06-11 15:09:07 +02:00
- [Typography](#typography)
2018-12-21 15:13:39 +01:00
- [License](#license)
---
2020-06-11 15:09:07 +02:00
## Brand Assets
2018-04-23 12:54:56 +02:00
- [Logo](logo/)
- [Banner](banner/)
2020-06-12 10:48:51 +02:00
- [Waves](waves/)
2020-06-11 15:09:07 +02:00
- [Creatures](creatures/)
2018-04-23 12:54:56 +02:00
- [GitHub](github/)
## Usage
2018-12-21 15:13:39 +01:00
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:
2018-06-04 17:16:22 +02:00
```bash
2018-06-18 16:10:26 +02:00
npm i @oceanprotocol/art
2018-06-04 17:16:22 +02:00
```
2020-06-11 15:09:07 +02:00
Then in your app, you can import the required assets:
2018-04-23 12:54:56 +02:00
2020-06-11 15:09:07 +02:00
```jsx
import logo from '@oceanprotocol/art/logo/logo.svg'
2018-04-23 12:54:56 +02:00
2020-06-11 15:09:07 +02:00
function MyComponent() {
return <img src={logo} />
}
2018-04-23 12:54:56 +02:00
```
2020-06-11 15:09:07 +02:00
## Typography
2018-04-23 12:54:56 +02:00
2020-06-11 15:09:07 +02:00
Our branding typefaces are [Sharp Sans Medium/Bold](https://sharptype.co/typefaces/sharp-sans/#features) in use as body text, and [Sharp Sans Display No. 1 Bold](https://sharptype.co/typefaces/sharp-sans-display-no1/) for headings.
2018-04-23 12:54:56 +02:00
2020-06-11 15:09:07 +02:00
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.
2018-04-23 12:54:56 +02:00
2020-07-01 11:35:44 +02:00
If you only need them for use on the web, you can use the private [`typographies`](https://github.com/oceanprotocol/typographies) npm package, or grab the font files itself from inside the private `site` repo's [fonts folder](https://github.com/oceanprotocol/site/tree/main/src/global/fonts).
2018-04-18 12:32:46 +02:00
## License
2019-03-26 16:25:29 +01:00
All assets are licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).