Skip to content

Commit 535c3e2

Browse files
committed
adjust documentation
1 parent 47210b2 commit 535c3e2

8 files changed

Lines changed: 57 additions & 100 deletions

File tree

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,14 @@ A production-ready React UI component library for Casper blockchain applications
1414

1515
Install from NPM to access ready-to-use components that bring the beloved Casper community UI to your dApp. Save time on design and implementation with clean, consistent look tailored for Web3.
1616

17-
**Battle-tested** components from production apps
18-
**Blockchain-focused** with CSPR-specific utilities
19-
**Consistent design** across the Casper ecosystem
20-
**TypeScript-first** with great developer experience
21-
**Zero configuration** - works out of the box
17+
**Battle-tested** components from production apps \
18+
**Blockchain-focused** with Casper-specific utilities \
19+
**Consistent design** across the Casper ecosystem
2220

2321
## Installation
2422

2523
```bash
26-
npm install github:make-software/cspr-design
24+
npm install @make-software/cspr-design
2725
```
2826

2927
## Quick Start
@@ -98,8 +96,8 @@ resolve: {
9896

9997
## Resources
10098

101-
📖 **[Full Documentation](https://docs.make.software/cspr.design/)** - Complete guide
102-
🎨 **[Storybook Demo](storybook-url)** - Interactive components
99+
📖 **[Full Documentation](https://cspr.design/)** - Complete guide
100+
🎨 **[Storybook](https://storybook.cspr.design/)** - Interactive components
103101
🐛 **[Report Issues](https://github.com/make-software/cspr-design/issues)** - Bugs & features
104102
💬 **[Community](telegram-url)** - Get help & discuss
105103

src/01-Home.mdx

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
import {Meta} from '@storybook/addon-docs/blocks';
2+
import {MenuBlocks, StyledHeaderWrapper, StyledWrapper} from "./storybook-components.tsx";
3+
4+
<Meta title="Home"/>
5+
6+
<StyledWrapper>
7+
<StyledHeaderWrapper>
8+
# Welcome to CSPR.design
9+
</StyledHeaderWrapper>
10+
</StyledWrapper>
11+
12+
<br/>
13+
<br/>
14+
15+
CSPR.design is a React-based UI component library powering the CSPR.suite application family, including [CSPR.live](https://cspr.live) and [Casper Wallet](https://www.casperwallet.io/).
16+
It provides a consistent design language, reusable components, and shared styling utilities to ensure a cohesive user experience across products. CSPR.design enables faster development, easier maintenance, and a unified brand presence throughout the Casper Ecosystem.
17+
18+
✅ Battle-tested components from production apps \
19+
✅ Blockchain-focused with Casper-specific utilities \
20+
✅ Consistent design across the Casper ecosystem
21+
<br/>
22+
23+
# Get started
24+
25+
Install from [NPM](https://www.npmjs.com/package/@make-software/cspr-design) to access ready-to-use components that bring the beloved [Casper blockchain](https://casper.networ) community UI to your dApp:
26+
27+
```
28+
npm install @make-software/cspr-design --save
29+
```
30+
31+
Save time on design and implementation with a consistent Casper Network look:
32+
``` tsx
33+
import {
34+
CSPR,
35+
BodyText,
36+
FlexColumn,
37+
} from '@make-software/cspr-design';
38+
39+
const balance = () => (
40+
<FlexColumn itemsSpacing={20}>
41+
<BodyText size={2}>Account balance:</BodyText>
42+
<CSPR
43+
motes="50000000000000"
44+
precisionCase={PrecisionCase.full}
45+
/>
46+
</FlexColumn>
47+
);
48+
```
49+
File renamed without changes.

src/Palette.mdx renamed to src/03-ColorPalette.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import {ColorItem, ColorPalette, Meta} from '@storybook/addon-docs/blocks';
22
import {themeConfig} from "./lib/index.js";
33
import {StyledHeaderWrapper, StyledWrapper} from "./storybook-components.tsx";
44

5-
<Meta title="Palette of colors"/>
5+
<Meta title="Color palette"/>
66

77
<StyledWrapper>
88
<StyledHeaderWrapper>
File renamed without changes.

src/Home.mdx

Lines changed: 0 additions & 49 deletions
This file was deleted.

src/Introduction.mdx

Lines changed: 0 additions & 41 deletions
This file was deleted.

src/storybook-components.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export const StyledHeaderWrapper = styled.span(({}) => ({
4343
export const StyledWrapper = styled.div(({}) => ({
4444
backgroundColor: '#181D40',
4545
width: '100%',
46-
height: '300px',
46+
height: '150px',
4747
display: 'flex',
4848
justifyContent: 'center',
4949
alignItems: 'center',

0 commit comments

Comments
 (0)