Skip to content

Commit 0450d92

Browse files
authored
📝 Update README.md
1 parent cf7844a commit 0450d92

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
<p align="center"><img src="https://i.imgur.com/AOEVomM.png" alt="Banner" /></p>
1111

12-
**Highway** is a *robust*, *modern* and *flexible* library that will let you create **AJAX navigations** with beautiful **transitions** on your websites. It's been a while we were trying to build this kind of library to fits our needs at [**Dogstudio**](https://www.dogstudio.co) and that hopefully will fit yours now we're releasing it!
12+
**Highway** is a *lightweight (**1.95ko** gzipped)*, *robust*, *modern* and *flexible* library that will let you create **AJAX navigations** with beautiful **transitions** on your websites. It's been a while we were trying to build this kind of library to fits our needs at [**Dogstudio**](https://www.dogstudio.co) and that hopefully will fit yours now we're releasing it!
1313

1414
## Table of Content
1515

@@ -19,6 +19,7 @@
1919
- [**Transitions**](https://github.com/Dogstudio/highway#transitions)
2020
- [**Events**](https://github.com/Dogstudio/highway#events)
2121
- [**Examples**](https://github.com/Dogstudio/highway#examples)
22+
- [**Support**](https://github.com/Dogstudio/highway#support)
2223
- [**Roadmap**](https://github.com/Dogstudio/highway#roadmap)
2324
- [**Releases**](https://github.com/Dogstudio/highway#releases)
2425
- [**License**](https://github.com/Dogstudio/highway#license)
@@ -45,10 +46,6 @@ First let's *import* **Highway**:
4546
```javascript
4647
import Highway from '@dogstudio/highway';
4748
```
48-
or *require* it if you prefer:
49-
```javascript
50-
const Highway = require('@dogstudio/highway');
51-
```
5249

5350
Now **Highway** is available you need to create an instance of `Highway.Core` and give it your [**renderers**](https://github.com/Dogstudio/highway#renderers) and [**transitions**](https://github.com/Dogstudio/highway#transitions).
5451

@@ -109,7 +106,7 @@ About your HTML this is actually pretty simple... Remember the `router-view` you
109106

110107
### Javascript
111108

112-
On the Javascript-side it's again pretty simple... What you need to do is to create a custom renderer for your page that will extend `Highway.Renderer` and enable all the required methods in order to make you custom renderer work.
109+
On the Javascript-side it's again pretty simple... What you need to do is to create a custom renderer for your page that will extend `Highway.Renderer` and enable all the required methods in order to make your custom renderer work.
113110

114111
**home.js**
115112
```javascript
@@ -135,7 +132,6 @@ Besides the required methods from **Highway** present in the `Highway.Renderer`
135132

136133
- `this.page`: The full DOM of the page related to the renderer.
137134
- `this.view`: The `[router-view]` of the page related to the renderer.
138-
- `this.title`: The `document.title` of the page related to the renderer.
139135

140136
**home.js**
141137
```javascript
@@ -154,7 +150,7 @@ export default Home;
154150
```
155151

156152
Now your custom renderer is created you need to add it to the renderers list of `Highway.Core`...
157-
Remember the name you gave to you `router-view`, it's now time to relate it to your custom renderer.
153+
Remember the name you gave to your `router-view`, it's now time to relate it to your custom renderer.
158154

159155
```javascript
160156
// Import Renderers
@@ -181,7 +177,7 @@ Transitions in **Highway** are really simple, you need to extend `Highway.Transi
181177
- `in`: The `in` method should contain the transition to show a `[router-view]`.
182178
- `out`: The `out` method should contain the transition to hide a `[router-view]`.
183179

184-
Each one get two parameters you can call howewer you want but here are good defaults:
180+
Each one get two parameters you can name howewer you want but here are good defaults:
185181

186182
- `view`: The `[router-view]` you will show/hide.
187183
- `done`: The callback method **you have to** call once the `in` and `out` transitions are over.
@@ -289,16 +285,29 @@ Check out the [**Basic Menu Active**](https://github.com/Dogstudio/highway/tree/
289285
- [**Basic Anchor**](https://github.com/Dogstudio/highway/tree/master/examples/basic-anchor)
290286
- [**Basic Google Analytics Events**](https://github.com/Dogstudio/highway/tree/master/examples/basic-google-analytics)
291287

288+
## Support
289+
290+
Note that **Highway** uses modern features because we wanted it to be *modern*. This means some browser might not support some of these modern features and you'll have to add a polyfill to your projects like [**babel-polyfill**](https://babeljs.io/docs/usage/polyfill/) or transpile your code to ES5 using tools like [**Webpack**](https://webpack.js.org/). This is a non-exhaustive list of modern features used in **Highway**:
291+
292+
- Classes
293+
- Object/Array Destructuring
294+
- Maps
295+
- Promises
296+
- Async...Await Functions
297+
- Fetch API
298+
- ...
299+
292300
## Roadmap
293301

294-
- [ ] More Unit Tests
302+
- [ ] Unit Tests
295303
- [ ] More Examples
296304

297305
## Releases
298306
#### 1.3.x
299307

300308
- Add the `Basic Anchor` example
301309
- Remove **modes** that weren't convincing
310+
- Improve code and weight with ES2016+ features
302311
- Improve events
303312
- Improve transitions
304313

0 commit comments

Comments
 (0)