|
7 | 7 |
|
8 | 8 | ### A collection of assets and guidelines for building consistent user experiences across OVHCloud products.
|
9 | 9 |
|
10 |
| -[![NPM version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url] [![Licence][licence-image]][licence-url] |
| 10 | +[![NPM version][npm-image]][npm-url] [](./LICENSE.md) [![Last commit][last-commit-image]][last-commit-url]\ |
| 11 | +[![StencilJS][stenciljs-image]][stenciljs-url] [![TypeScript][typescript-image]][typescript-url] [![Sass][sass-image]][sass-url]\ |
| 12 | +[![Storybook][storybook-image]][storybook-url] [![Jest][jest-image]][jest-url] [![Puppeteer][puppeteer-image]][puppeteer-url] |
11 | 13 |
|
12 |
| -[![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] |
13 |
| - |
14 |
| -[npm-image]: https://www.npmjs.com/package/@ovhcloud/ods-components |
| 14 | +[npm-image]: https://img.shields.io/badge/-NPM-A00709?logo=npm&logoColor=white |
15 | 15 | [npm-url]: https://www.npmjs.com/package/@ovhcloud/ods-components
|
16 |
| -[download-image]: https://img.shields.io/npm/dm/@ovhcloud/ods-core.svg?style=flat |
17 |
| -[download-url]: https://www.npmjs.com/package/@ovhcloud/ods-core |
18 |
| -[licence-image]: https://img.shields.io/github/license/ovh/design-system |
19 |
| -[licence-url]: LICENSE.md |
| 16 | +[last-commit-image]: https://img.shields.io/github/last-commit/ovh/design-system |
| 17 | +[last-commit-url]: https://github.com/ovh/design-system/commits |
20 | 18 | [stenciljs-image]: https://img.shields.io/badge/-StencilJS-000?logo=webcomponents.org&logoColor=white
|
21 | 19 | [stenciljs-url]: https://stenciljs.com/
|
22 | 20 | [typescript-image]: https://img.shields.io/badge/-TypeScript-3178C6?logo=typescript&logoColor=white
|
|
35 | 33 | ## Quick links
|
36 | 34 |
|
37 | 35 | * [**Storybook**](https://ovh.github.io/design-system/latest/)
|
38 |
| -* [**What's new**](https://ovh.github.io/design-system/latest/?path=/story/ovhcloud-design-system-what-s-new-what-s-new--page) |
39 |
| -* [**Changelog**](https://ovh.github.io/design-system/latest/?path=/story/ovhcloud-design-system-what-s-new-changelog--page) |
40 |
| - |
41 |
| -### Requirements (only for contributing) |
42 |
| - |
43 |
| -* [**Node.js**](https://nodejs.org/en/) with version ">= 18.17" |
44 |
| -* [**Yarn**](https://yarnpkg.com/) with version ">= 2.4" |
45 |
| - |
46 |
| -## Installation |
47 |
| - |
48 |
| -All the OVHCloud Design System packages are available on [**NPM**](https://www.npmjs.com/). |
49 |
| - |
50 |
| -```sh |
51 |
| -yarn add @ovhcloud/ods-components @ovhcloud/ods-themes |
52 |
| -``` |
53 |
| -or |
54 |
| -```sh |
55 |
| -npm install --save @ovhcloud/ods-components @ovhcloud/ods-themes |
56 |
| -``` |
57 |
| - |
58 |
| -## Usage |
59 |
| - |
60 |
| -Components can be imported using one of: |
61 |
| -```typescript |
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' |
65 |
| -``` |
66 |
| - |
67 |
| -Then, in your view, you can start using ODS components. For instance: |
68 |
| -```html |
69 |
| -<ods-button label="My Button"> |
70 |
| -</ods-button> |
71 |
| -``` |
72 |
| - |
73 |
| -For more detail, see our global [Get Started](https://ovh.github.io/design-system/latest/?path=/story/ovhcloud-design-system-get-started--page) guide |
74 |
| - |
75 |
| -## Contribute |
76 |
| -You've developed a new cool feature? Fixed an annoying bug? We'd be happy to hear from you! |
| 36 | +* [**What's new**](https://ovh.github.io/design-system/latest/?path=/docs/ovhcloud-design-system-what-s-new-what-s-new--docs) |
| 37 | +* [**Changelog**](https://ovh.github.io/design-system/latest/?path=/docs/ovhcloud-design-system-what-s-new-changelog--docs) |
77 | 38 |
|
78 |
| -Please read [Get Started](https://ovh.github.io/design-system/latest/?path=/story/contributing-get-started--page) guide for contributing and [CONTRIBUTING.md](https://github.com/ovh/design-system/blob/master/CONTRIBUTING.md) 😃 |
| 39 | +## Installation & Usage |
| 40 | +Feel free to check out the [Get Started](https://ovh.github.io/design-system/latest/?path=/docs/ovhcloud-design-system-get-started--docs) guide which describes everything you need to use ODS in your project. |
79 | 41 |
|
80 | 42 | ## Migration
|
81 |
| -Please read [Migration pages](https://ovh.github.io/design-system/latest/?path=/story/ovhcloud-design-system-what-s-new-migration-guide-12-x-to-13-x--page) to help you to manage the migration guides between each version of ODS. |
| 43 | +Please read [Migration pages](https://ovh.github.io/design-system/latest/?path=/docs/ovhcloud-design-system-what-s-new-migration-guide-17-x-to-18-x--docs) to help you to manage the migration guides between each version of ODS. |
82 | 44 |
|
83 | 45 | # Related links
|
84 |
| -* Contribute: [https://github.com/ovh/design-system/blob/master/CONTRIBUTING.md](https://github.com/ovh/design-system/blob/master/CONTRIBUTING.md) |
85 |
| -* Migrate from one version to another: [https://github.com/ovh/design-system/blob/master/MIGRATION.md](https://github.com/ovh/design-system/blob/master/MIGRATION.md) |
86 |
| -* Troubleshoot dev issues: [https://github.com/ovh/design-system/blob/master/TROUBLESHOOTING.md](https://github.com/ovh/design-system/blob/master/TROUBLESHOOTING.md) |
| 46 | +* Migrate from one version to another: [https://ovh.github.io/design-system/latest/?path=/docs/ovhcloud-design-system-what-s-new-migration-guide-17-x-to-18-x--docs](https://ovh.github.io/design-system/latest/?path=/docs/ovhcloud-design-system-what-s-new-migration-guide-17-x-to-18-x--docs) |
| 47 | +* Troubleshoot dev issues: [https://ovh.github.io/design-system/latest/?path=/docs/ovhcloud-design-system-f-a-q--docs](https://ovh.github.io/design-system/latest/?path=/docs/ovhcloud-design-system-f-a-q--docs) |
87 | 48 | * Report bugs: [https://github.com/ovh/design-system/issues](https://github.com/ovh/design-system/issues)
|
88 |
| -* Get latest version: [https://github.com/ovh/ods](https://github.com/ovh/ods) |
| 49 | +* Get latest version: [https://github.com/ovh/design-system](https://github.com/ovh/design-system) |
89 | 50 |
|
90 | 51 | # License
|
91 |
| -Copyright 2023 OVH SAS |
| 52 | +Copyright 2024 OVH SAS |
92 | 53 |
|
93 | 54 | Licensed under the Apache License, Version 2.0 (the "License");
|
94 | 55 | you may not use this file except in compliance with the License.
|
|
0 commit comments