Skip to content
This repository was archived by the owner on Aug 7, 2020. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 33 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,14 @@ bower install --save ovh-ui-angular

## Usage

### Integration

1. In your `index.html`, you need to load `oui-angular.min.js`:

```html
...
<script src="ovh-ui-angular/dist/oui-angular.min.js" type="text/javascript"></script>
...
...
<script src="ovh-ui-angular/dist/oui-angular.min.js" type="text/javascript"></script>
...
```

2. You need to add `oui` in your angular module dependencies like that:
Expand All @@ -63,7 +65,34 @@ angular.module("myAwesomeApp", [
]);
```

## Developers
## Develop

### Run in development mode

1. Clone and install `ovh-ui-kit`

```bash
git clone https://github.com/ovh-ux/ovh-ui-kit.git
cd ovh-ui-kit
yarn install
yarn link
```

2. Run `ovh-ui-kit` with [ovh-ui-kit-documentation](https://github.com/ovh-ux/ovh-ui-kit-documentation)

```bash
git clone https://github.com/ovh-ux/ovh-ui-kit-documentation.git
cd ovh-ui-kit-documentation
yarn install
yarn link ovh-ui-kit
yarn start
```

### Hot reload

Once you have `yarn start`-ed the project, you can edit anything with an automatic browser refresh as a result.

### Contributing

You've developed a new cool feature? Fixed an annoying bug? We'd be happy
to hear from you!
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"babel-register": "^6.18.0",
"cross-env": "^5.1.0",
"css-loader": "^0.28.4",
"eslint": "^4.3.0",
"eslint": "^3.13.1",
"eslint-config-ovh": "^0.1.1",
"eslint-friendly-formatter": "^3.0.0",
"eslint-loader": "^1.9.0",
Expand Down
Loading