Skip to content

Commit 89eb1d3

Browse files
committed
chore(project): remove old code source
1 parent 43cc43a commit 89eb1d3

File tree

4 files changed

+19
-43
lines changed

4 files changed

+19
-43
lines changed

README.md

+18-35
Original file line numberDiff line numberDiff line change
@@ -5,86 +5,69 @@
55
</p>
66
<div align="center">
77

8-
### A collection of assets and guidelines for building consistent user experiences across OVHcloud products.
8+
### A collection of assets and guidelines for building consistent user experiences across OVHCloud products.
99

10-
[![NPM version][npm-image]][npm-url] [![CI status][github-action-image]][github-action-url] [![NPM downloads][download-image]][download-url] [![Licence][licence-image]][licence-url]
10+
[![NPM version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url] [![Licence][licence-image]][licence-url]
1111

1212
[![StencilJS][stenciljs-image]][stenciljs-url] [![TypeScript][typescript-image]][typescript-url] [![Sass][sass-image]][sass-url] [![Storybook][storybook-image]][storybook-url] [![Jest][jest-image]][jest-url] [![Puppeteer][puppeteer-image]][puppeteer-url]
1313

14-
[npm-image]: https://img.shields.io/npm/v/@ovhcloud/ods-core
15-
[npm-url]: https://www.npmjs.com/package/@ovhcloud/ods-core
16-
[github-action-image]: https://github.com/ovh/design-system/actions/workflows/ci.yml/badge.svg
17-
[github-action-url]: https://github.com/ovh/design-system/actions/workflows/ci.yml
14+
[npm-image]: https://www.npmjs.com/package/@ovhcloud/ods-components
15+
[npm-url]: https://www.npmjs.com/package/@ovhcloud/ods-components
1816
[download-image]: https://img.shields.io/npm/dm/@ovhcloud/ods-core.svg?style=flat
1917
[download-url]: https://www.npmjs.com/package/@ovhcloud/ods-core
2018
[licence-image]: https://img.shields.io/github/license/ovh/design-system
2119
[licence-url]: LICENSE.md
2220
[stenciljs-image]: https://img.shields.io/badge/-StencilJS-000?logo=webcomponents.org&logoColor=white
2321
[stenciljs-url]: https://stenciljs.com/
2422
[typescript-image]: https://img.shields.io/badge/-TypeScript-3178C6?logo=typescript&logoColor=white
25-
[typescript-url]: https://stenciljs.com/
23+
[typescript-url]: https://www.typescriptlang.org/
2624
[sass-image]: https://img.shields.io/badge/-Sass-CC6699?logo=sass&logoColor=white
2725
[sass-url]: https://sass-lang.com/
2826
[storybook-image]: https://cdn.jsdelivr.net/gh/storybookjs/brand@master/badge/badge-storybook.svg
2927
[storybook-url]: https://storybook.js.org/
3028
[jest-image]: https://img.shields.io/badge/-Jest-C21325?logo=jest&logoColor=white
31-
[jest-url]: https://jestjs.io/fr/
29+
[jest-url]: https://jestjs.io/
3230
[puppeteer-image]: https://img.shields.io/badge/-Puppeteer-40B5A4?logo=puppeteer&logoColor=white
3331
[puppeteer-url]: https://pptr.dev/
3432

3533
</div>
3634

3735
## Quick links
38-
* [**Storybook (current version)**](https://ovh.github.io/design-system/latest/)
39-
* [**All ODS versions**](https://ovh.github.io/design-system/)
36+
37+
* [**Storybook**](https://ovh.github.io/design-system/latest/)
4038
* [**What's new**](https://ovh.github.io/design-system/latest/?path=/story/ovhcloud-design-system-what-s-new-what-s-new--page)
4139
* [**Changelog**](https://ovh.github.io/design-system/latest/?path=/story/ovhcloud-design-system-what-s-new-changelog--page)
42-
* [**Global Documentation 🔗**](https://zeroheight.com/6fc8a63f7/p/533db0-ovhcloud-design-system)
4340

4441
### Requirements (only for contributing)
42+
4543
* [**Node.js**](https://nodejs.org/en/) with version ">= 18.17"
4644
* [**Yarn**](https://yarnpkg.com/) with version ">= 2.4"
4745

4846
## Installation
49-
All the OVHcloud Design System packages are available on [**NPM**](https://www.npmjs.com/).
47+
48+
All the OVHCloud Design System packages are available on [**NPM**](https://www.npmjs.com/).
5049

5150
```sh
52-
yarn add @ovhcloud/ods-components @ovhcloud/ods-theme-blue-jeans
51+
yarn add @ovhcloud/ods-components @ovhcloud/ods-themes
5352
```
5453
or
5554
```sh
56-
npm install --save @ovhcloud/ods-components @ovhcloud/ods-theme-blue-jeans
55+
npm install --save @ovhcloud/ods-components @ovhcloud/ods-themes
5756
```
5857

5958
## Usage
60-
To start using ODS, you'll need to import the components.
61-
62-
Add a dependency to either:
63-
* `@ovhcloud/ods-components` to import all components
64-
* `@ovhcloud/ods-components-<component>` to import a specific component
6559

6660
Components can be imported using one of:
6761
```typescript
68-
import { Osds<Component> } from '@ovhcloud/ods-component-<component>'
69-
import { Osds<Component> } from '@ovhcloud/ods-component-<component>/react'
70-
import { Osds<Component> } from '@ovhcloud/ods-component-<component>/vue'
71-
```
72-
73-
You can import enums directly from the component:
74-
```typescript
75-
import { ODS_%COMPONENT%_SIZE, ODS_%COMPONENT%_SIZES } from '@ovhcloud/ods-component-<component>'
76-
```
77-
78-
Same goes for interfaces:
79-
```typescript
80-
import type { Ods<Component>Attribute } from '@ovhcloud/ods-component-<component>'
62+
import { Ods<Component> } from '@ovhcloud/ods-components>'
63+
import { Ods<Component> } from '@ovhcloud/ods-components/react'
64+
import { Ods<Component> } from '@ovhcloud/ods-components/vue'
8165
```
8266

8367
Then, in your view, you can start using ODS components. For instance:
8468
```html
85-
<osds-button>
86-
My Button
87-
</osds-button>
69+
<ods-button label="My Button">
70+
</ods-button>
8871
```
8972

9073
For more detail, see our global [Get Started](https://ovh.github.io/design-system/latest/?path=/story/ovhcloud-design-system-get-started--page) guide

assets/ODS_logo.svg

-1
This file was deleted.

0 commit comments

Comments
 (0)