Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 911 Bytes

README.md

File metadata and controls

40 lines (26 loc) · 911 Bytes
Raw

pocketUI

Overview

pocketUI is a React library used to build user interfaces for Pocket Network and its related projects. It provides the components needed to build experiences that embody the principles of the nascent Pocket Design System, and can be used with both client or server side rendering.

The complete documentation will be coming soon!

Quick setup

Install pocketUI alongside styled-components from npm:

pnpm install --save @pocket-foundation/ui styled-components

Wrap your app with the Main component:

import React from 'react'
import { Main } from '@pokt-foundation/ui'

function App() {
  return (
    <Main>
      <h1>Hello pocketUI!</h1>
    </Main>
  )
}

Your project is now ready to use pocketUI. 💫

Build and Develop

Please have a look at CONTRIBUTING.md.

License

MIT, see LICENSE.