Skip to content

Commit

Permalink
Merge pull request #26 from telicent-oss/update(README.md)/tweaks
Browse files Browse the repository at this point in the history
update(README.md): tweaks
  • Loading branch information
ACoolmanTelicent authored Mar 19, 2024
2 parents 2f5a641 + 2cbb27a commit e3978dc
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Telicent Design System (DS)

A component library to help developers create frontend applications for Telicent platform apps. Visit the [Storybook](https://telicent-oss.github.io/ds/) to learn more.
A component library to help developers create frontend applications for [Telicent.io](https://telicent.io/) platform apps.

This repo contains:
1. ReactJS Components that adhere to the _Design System rules_<sup>1</sup>
2. A generated [Storybook](https://telicent-oss.github.io/ds/), describing the components

<sup>1</sup> The _Design System rules_ are contained in a Figma file (private for now)

## Install

Expand Down Expand Up @@ -31,5 +37,5 @@ import { TeliStandardLayout } from '@telicent-oss/ds';
```sh
git clone https://github.com/Telicent-oss/telicent-ds.git
cd telicent-ds
yarn storybook
```
yarn && yarn storybook
```

0 comments on commit e3978dc

Please sign in to comment.