Skip to content

Commit

Permalink
Merge pull request #43 from rancher/add-license-info
Browse files Browse the repository at this point in the history
Add license info and copyright year
  • Loading branch information
nwmac authored Jan 15, 2024
2 parents f0bc782 + 4bf0471 commit 5913218
Showing 1 changed file with 25 additions and 11 deletions.
36 changes: 25 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
api-ui
========
# api-ui

An embedded UI for any service that implements the Rancher API spec.

Integrating with your API
-------
See [HTML UI](https://github.com/rancherio/api-spec/blob/master/specification.md#html-ui) in the API specification. This also includes a link to the latest version hosted on our CDN.

Install
--------
## Install

```bash
git clone https://github.com/rancherio/api-ui
cd api-ui
yarn install
```

Usage
--------
## Usage

### Compiling into stand-alone CSS and JavaScript files
This will write files to `./dist/{version}/`, suitable for publishing to a CDN.
Expand All @@ -25,8 +23,8 @@ This will write files to `./dist/{version}/`, suitable for publishing to a CDN.
./scripts/build
```

Integrating with an API
--------
### Integrating with an API

Wrap JSON responses with a bit of HTML (and return `Content-Type: text/html`):
```html
<!DOCTYPE html>
Expand All @@ -43,8 +41,8 @@ var data = {
</script>
```

Options
------
### Options

Several options can be configured through additional globals:

```javascript
Expand All @@ -68,7 +66,23 @@ var curlUser = "some:thing";
var bootstrap = "http://url/to/bootstrap/version";
```

### Bugs & Issues
## Bugs & Issues
Please submit bugs and issues to [rancher/dashboard](//github.com/rancher/dashboard/issues) with a title starting with `[API UI] `.

Or just [click here](//github.com/rancher/dashboard/issues/new?title=%5BAPI%20UI%5D%20) to create a new issue.

## License

Copyright (c) 2014-2024 [Rancher Labs, Inc.](http://rancher.com)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

0 comments on commit 5913218

Please sign in to comment.