Skip to content

Commit 0f22278

Browse files
authored
Fix readme (#271)
1 parent 48e4b4b commit 0f22278

File tree

2 files changed

+14
-36
lines changed

2 files changed

+14
-36
lines changed

README.md

+1-32
Original file line numberDiff line numberDiff line change
@@ -5,40 +5,9 @@
55
yarn install
66
```
77

8-
## Font variables setup
9-
Required!: Add scss font variables to your project
10-
11-
```
12-
$s-font-family-default-path: '~@soramitsu/soramitsu-js-ui/lib/assets/fonts/Sora-VariableFont_wght.ttf' !default;
13-
$s-font-family-mono-path: '~@soramitsu/soramitsu-js-ui/lib/assets/fonts/JetBrainsMono-Regular.woff' !default;
14-
$s-font-family-icons-path: '~@soramitsu/soramitsu-js-ui/lib/assets/fonts/soramitsu-icons-1.0.0.ttf' !default;
15-
```
16-
178
## Usage library in project
18-
### 1.Install all of library components:
19-
```
20-
import Vue from 'vue
21-
import SoramitsuElements from '@soramitsu/soramitsu-js-ui'
229

23-
const options = {
24-
store // if u want to merge ui lib modules
25-
}
26-
27-
Vue.use(SoramitsuElements, options)
28-
```
29-
### 2.Install only necessary components (to reduce vendors bundle size)
30-
```
31-
import Vue from 'vue
32-
import ElementUIPlugin from '@soramitsu/soramitsu-js-ui/lib/plugins/elementUI'
33-
import SoramitsuUIStorePlugin from '@soramitsu/soramitsu-js-ui/lib/plugins/soramitsuUIStore'
34-
import SButton from '@soramitsu/soramitsu-js-ui/lib/components/Button/SButton'
35-
import SButton from '@soramitsu/soramitsu-js-ui/lib/components/Input/SInput'
36-
37-
Vue.use(ElementUIPlugin) // required
38-
Vue.use(SoramitsuUIStorePlugin, store) // optional
39-
Vue.use(SButton)
40-
Vue.use(SInput)
41-
```
10+
The full guide about usage can be found [here](./src/stories/Intro/Intro.stories.mdx)
4211

4312
### Compiles and hot-reloads storybook with components for development
4413
```

src/stories/Intro/Intro.stories.mdx

+13-4
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ npm login --registry="https://nexus.iroha.tech/repository/npm-group/"
2222

2323
# 2. Add as a dependency to the project
2424

25-
Add `"@soramitsu/soramitsu-js-ui": "^0.3.4"` in `package.json` file (`"dependencies"` section)
25+
Add `"@soramitsu/soramitsu-js-ui": "version"` in `package.json` file (`"dependencies"` section)
2626

2727
OR RUN
2828

2929
`yarn add "@soramitsu/soramitsu-js-ui"`
3030

31-
# 3. Add components with styles to the project
31+
# 3. Add components with utilities to the project
3232

3333
For instance, `soramitsuUI.ts`:
3434

@@ -57,7 +57,7 @@ setTheme(Theme.LIGHT)
5757
setDesignSystem(DesignSystem.NEUMORPHIC)
5858
```
5959

60-
You could also use direct components import:
60+
You could also use direct components import to reduce vendors bundle size:
6161

6262
```
6363
import Vue from 'vue'
@@ -92,11 +92,16 @@ Add `"element-ui"` in `tsconfig.json` file (`"types"` section)
9292

9393
# 5. Add all required styles
9494

95-
The previous section added not all required styles. To fix it you should add imports into `scss` file.
95+
The previous sections added not all required styles. To fix it you should add imports into `scss` file.
96+
Also, you should add **Font variables**
9697

9798
For instance, `soramitsu-variables.scss`:
9899

99100
```
101+
$s-font-family-default-path: '~@soramitsu/soramitsu-js-ui/lib/assets/fonts/Sora-VariableFont_wght.ttf' !default;
102+
$s-font-family-mono-path: '~@soramitsu/soramitsu-js-ui/lib/assets/fonts/JetBrainsMono-Regular.woff' !default;
103+
$s-font-family-icons-path: '~@soramitsu/soramitsu-js-ui/lib/assets/fonts/soramitsu-icons-1.0.0.ttf' !default;
104+
100105
@import '~@soramitsu/soramitsu-js-ui/lib/styles/index';
101106
```
102107

@@ -110,6 +115,10 @@ $s-color-theme-accent: #ED145B;
110115
// Basic colors
111116
$s-color-base-content-primary: #0D0248;
112117
118+
$s-font-family-default-path: '~@soramitsu/soramitsu-js-ui/lib/assets/fonts/Sora-VariableFont_wght.ttf' !default;
119+
$s-font-family-mono-path: '~@soramitsu/soramitsu-js-ui/lib/assets/fonts/JetBrainsMono-Regular.woff' !default;
120+
$s-font-family-icons-path: '~@soramitsu/soramitsu-js-ui/lib/assets/fonts/soramitsu-icons-1.0.0.ttf' !default;
121+
113122
@import '~@soramitsu/soramitsu-js-ui/lib/styles/index';
114123
115124
```

0 commit comments

Comments
 (0)