Skip to content

Commit

Permalink
docs(README): update greenkeeper badge for consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
elboman committed Jan 30, 2018
1 parent daefe7f commit 5611699
Showing 1 changed file with 20 additions and 19 deletions.
39 changes: 20 additions & 19 deletions README.md
Expand Up @@ -8,25 +8,26 @@
<img src="https://img.shields.io/npm/v/@uirouter/react.svg?style=flat-square">
</a>
<a href="https://greenkeeper.io/">
<img src="https://badges.greenkeeper.io/ui-router/react.svg?style=flat-square" alt="Greenkeeper badge">
<img src="https://img.shields.io/badge/Greenkeeper-enabled-green.svg?style=flat-square" alt="Greenkeeper badge">
</a>
</div>

UI-Router provides extremely flexible, state based routing to the [React](https://facebook.github.io/react/) ecosystem.

Routing frameworks for SPAs update the browser's URL as the user navigates through the app. Conversely, this allows changes to the browser's URL to drive navigation through the app, thus allowing the user to create a bookmark to a location deep within the SPA.
Routing frameworks for SPAs update the browser's URL as the user navigates through the app. Conversely, this allows changes to the browser's URL to drive navigation through the app, thus allowing the user to create a bookmark to a location deep within the SPA.

UI-Router applications are modeled as a hierarchical tree of states. UI-Router provides a [*state machine*](https://en.wikipedia.org/wiki/Finite-state_machine) to manage the transitions between those application states in a transaction-like manner.
UI-Router applications are modeled as a hierarchical tree of states. UI-Router provides a [_state machine_](https://en.wikipedia.org/wiki/Finite-state_machine) to manage the transitions between those application states in a transaction-like manner.

## Docs & Resources

- [Tutorials and Docs](/docs)
- [Examples](/examples)
- [UI-Router website](https://ui-router.github.io/)
- [Changelog](/CHANGELOG.md)
- [Upgrading from `0.3.x` to `0.4.x`](/docs/upgrading-from-0.3.x-to-0.4.x.md)
* [Tutorials and Docs](/docs)
* [Examples](/examples)
* [UI-Router website](https://ui-router.github.io/)
* [Changelog](/CHANGELOG.md)
* [Upgrading from `0.3.x` to `0.4.x`](/docs/upgrading-from-0.3.x-to-0.4.x.md)

## Getting started

The UI-Router package is distributed using [npm](https://www.npmjs.com/), the node package manager.

```
Expand All @@ -38,25 +39,25 @@ Import `UIRouter` into your project, define some states and you're good to go!
```jsx
import React from 'react';
import ReactDOM from 'react-dom';
import {UIRouter, UIView, pushStateLocationPlugin} from '@uirouter/react';
import { UIRouter, UIView, pushStateLocationPlugin } from '@uirouter/react';
import Home from './components/Home';

// define your states
const states = [{
name: 'home',
url: '/home',
component: Home
}];
const states = [
{
name: 'home',
url: '/home',
component: Home,
},
];

// select your plugins
const plugins = [
pushStateLocationPlugin
];
const plugins = [pushStateLocationPlugin];

ReactDOM.render(
<UIRouter plugins={plugins} states={states}>
<UIView/>
<UIView />
</UIRouter>,
document.getElementById('root')
document.getElementById('root'),
);
```

0 comments on commit 5611699

Please sign in to comment.