Skip to content

Commit

Permalink
rephrasing readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JeanMarcMilletScality committed Jan 18, 2024
1 parent 875b2ce commit 7a110f0
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Welcome to Scality Core-UI

Core-UI is a components library containing all components, layouts, icons and themes for all Scality UI projects. \
This project uses [React](https://react.dev/) with [TypeScript](https://www.typescriptlang.org/), and components are styled by using [styled-components](https://styled-components.com/).

Core-UI is a component library containing all components, layouts, icons and themes used for all Scality UI projects. \
This project is built with [React](https://react.dev/) and [TypeScript](https://www.typescriptlang.org/), and styled with [styled-components](https://styled-components.com/).

## Getting started

Expand Down Expand Up @@ -55,7 +54,7 @@ npm install

- Import a component from ```@scality/core-ui/dist/next'``` or ```@scality/core-ui```

- Pass it props to change its appearence and behaviour
- Pass it props to change its appearance and behaviour

```jsx
import { Button } from '@scality/core-ui/dist/next';
Expand All @@ -73,7 +72,7 @@ Components are themable by using the [styled-components theming concept](https:/
Wrap your app in a ```ThemeProvider``` and provide it a theme.
The theme needs to be defined as below :

```javascript
```jsx

import { ThemeProvider } from 'styled-components';
import { Layout } from '@scality/core-ui';
Expand Down Expand Up @@ -109,6 +108,7 @@ const theme = {
...
</Layout>
</ThemeProvider>

```

## Available Scripts
Expand Down

0 comments on commit 7a110f0

Please sign in to comment.