@0xsquid/ui 0.3.0 → 1.0.0

package/README.md

@@ -2,36 +2,7 @@
 
 React components library for Squid V2
 
-## Package installation and usage
-
-Install the package:
-
-```bash
-yarn add @0xsquid/ui
-```
-
-Import styles in your entry point:
-
-```jsx
-// src/main.tsx | src/pages/_app.tsx | etc...
-import '@0xsquid/ui/dist/index.css'
-```
-
-Wrap your app with our theme provider `<SquidConfigProvider />` and specify your theme:
-
-```jsx
-import { SquidConfigProvider, Button } from '@0xsquid/ui'
-
-function App() {
-  return (
-    <SquidConfigProvider theme={yourTheme}>
-      <Button label="Hello world" variant="primary" size="md" />
-    </SquidConfigProvider>
-  )
-}
-```
-
-## Development
+## Getting Started
 
 ### Install dependencies
 
@@ -44,49 +15,3 @@ yarn install
 ```bash
 yarn storybook
 ```
-
-### Build package
-
-To build the package using Rollup, run:
-
-```bash
-yarn build
-```
-
-This command will:
-
-1. compile Tailwind CSS classes into `src/styles/compiled-tailwind.css`
-2. bundle source code, along with its type declarations, into the `dist/` folder
-3. copy `src/styles/compiled-tailwind.css` to `dist/index.css`
-
-### Lint and format
-
-To format and lint the code, run:
-
-```bash
-yarn format:fix
-```
-
-```bash
-yarn lint:fix
-```
-
-### Images
-
-In case you need to add images somewhere that need to be included in the final bundle, convert them to base64 instead.
-
-Example:
-
-```diff
-.my-image {
--  background-image: url('my-image.png');
-+  background-image: url('data:image/png;base64,iVBORw0...');
-}
-```
-
-Or in a React component:
-
-```diff
--  <img src="my-image.png" />
-+  <img src="data:image/png;base64,iVBORw0..." />
-```