Skip to content

Commit

Permalink
Updating doc
Browse files Browse the repository at this point in the history
  • Loading branch information
akadlec committed Jul 16, 2021
1 parent 47b93b6 commit df569e4
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 10 deletions.
46 changes: 40 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,19 @@

This library is a collection of [Vue](https://vuejs.org) framework components used for [FastyBird](https://www.fastybird.com) web application user interfaces.

[FastyBird](https://www.fastybird.com) [IoT](https://en.wikipedia.org/wiki/Internet_of_things) web-ui theme library is an [Apache2 licensed](http://www.apache.org/licenses/LICENSE-2.0) distributed library, developed in [Typescript](https://www.typescriptlang.org) with [Vue](https://vuejs.org) and [Nuxt](https://nuxtjs.org).

### Features:

- Web user interface elements like modal windows, buttons, alerts, switches etc.
- Forms elements with support for pre and post-fixes
- Page layout components for desktop and mobile views
- Customizable styles

## Requirements

Library is tested against [ECMAScript 6](https://www.w3schools.com/JS/js_es6.asp)

## Installation

The best way to install **@fastybird/web-ui-theme** is using [Yarn](https://yarnpkg.com/):
Expand Down Expand Up @@ -68,14 +81,35 @@ Add the types to your `"types"` array in **tsconfig.json**.
}
```

#### Some constants:
## Documentation

Learn how to use ui components in [documentation](https://storybook.fastybird.com/).

## Feedback

Use the [issue tracker](https://github.com/FastyBird/web-ui-theme/issues) for bugs or [mail](mailto:[email protected]) or [Tweet](https://twitter.com/fastybird) us for any idea that can improve the project.

Thank you for testing, reporting and contributing.

## Changelog

For release info check [release page](https://github.com/FastyBird/web-ui-theme/releases)

Defined sizes are:
## Maintainers

- small: 5px
- normal: 10px
- medium: 15px
- large: 30px
<table>
<tbody>
<tr>
<td align="center">
<a href="https://github.com/akadlec">
<img width="80" height="80" src="https://avatars3.githubusercontent.com/u/1866672?s=460&amp;v=4">
</a>
<br>
<a href="https://github.com/akadlec">Adam Kadlec</a>
</td>
</tr>
</tbody>
</table>

***
Homepage [https://www.fastybird.com](https://www.fastybird.com) and repository [https://github.com/FastyBird/web-ui-theme](https://github.com/FastyBird/web-ui-theme).
8 changes: 4 additions & 4 deletions src/stories/spacing.stories.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ export const Spacing: Story = () => {
return {
template: `
<div class="fb-story-spacing__container">
<p>Extra small:</p>
<p>Extra small (5px):</p>
<div class="fb-story-spacing__box-extra-small" />
<p>Small:</p>
<p>Small (10px):</p>
<div class="fb-story-spacing__box-small" />
<p>Medium:</p>
<p>Medium (15px):</p>
<div class="fb-story-spacing__box-medium" />
<p>Large:</p>
<p>Large (30px):</p>
<div class="fb-story-spacing__box-large" />
</div>
`,
Expand Down

0 comments on commit df569e4

Please sign in to comment.