Skip to content

Commit 72271ea

Browse files
committed
README updates (rawgit instead of relative)
1 parent d914fa4 commit 72271ea

File tree

3 files changed

+29
-41
lines changed

3 files changed

+29
-41
lines changed

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11

2-
<img src="assets/header.png" width="320" >
2+
<img src="https://github.com/timolins/hyperlayout/raw/master/assets/header.png" width="320" >
33

44
> Layout presets for [Hyper.app](https://hyper.is)
55
66

77
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
8-
## Install
8+
# Install
99

1010
```sh
1111
$ npm install -g hyperlayout hpm-cli
1212
$ hpm install hyperlayout
1313
```
1414

15-
## Usage
15+
# Usage
1616
To get started, setup a layout inside of `package.json`.
1717

1818
_Alternatively you can define it inside of `.hyperlayout` or `~/.hyperlayout`._
@@ -36,11 +36,10 @@ To apply the layout, simply run `hyperlayout` in the same directory.
3636
$ hyperlayout
3737
```
3838
#### Result
39-
![Demo 1](assets/demo1.svg)
39+
![Demo 1](https://cdn.rawgit.com/timolins/hyperlayout/master/assets/demo1.svg)
4040

41-
---
4241

43-
### Advanced example
42+
## Advanced example
4443
This example shows the capabilities of `hyperlayout`.
4544

4645
> `package.json`
@@ -76,15 +75,15 @@ Since there are two layouts defined here, you have to tell `hyperlayout` which o
7675
$ hyperlayout start
7776
```
7877
#### Result
79-
![Demo 2](assets/demo2.svg)
78+
![Demo 2](https://cdn.rawgit.com/timolins/hyperlayout/master/assets/demo2.svg)
8079

81-
## Examples
82-
![Example 1](assets/example1.svg) **Tabs**
80+
# Examples
81+
![Example 1](https://cdn.rawgit.com/timolins/hyperlayout/master/assets/example1.svg) **Tabs**
8382
```json
8483
["1", "2"]
8584
```
8685
---
87-
![Example 2](assets/example2.svg) **Horizontal Panes**
86+
![Example 2](https://cdn.rawgit.com/timolins/hyperlayout/master/assets/example2.svg) **Horizontal Panes**
8887
```json
8988
[["1", "2"]]
9089
```
@@ -96,7 +95,7 @@ or
9695
}
9796
```
9897
---
99-
![Example 3](assets/example3.svg) **Vertical Panes**
98+
![Example 3](https://cdn.rawgit.com/timolins/hyperlayout/master/assets/example3.svg) **Vertical Panes**
10099
```json
101100
[[["1", "2"]]]
102101
```
@@ -108,5 +107,8 @@ or
108107
}
109108
```
110109

111-
## License
112-
`hyperlayout` was written by [Timo Lins](https://timo.sh).
110+
# Known Issues
111+
* It isn't possible layout multiple windows at once. If you know how to approach this feature, then head over to [Issue #2](https://github.com/timolins/hyperlayout/issues/2) and let me know!
112+
113+
# Author
114+
`hyperlayout` was written by [Timo Lins](https://timo.sh).

art/hyperlayout.sketch

8 KB
Binary file not shown.

assets/demo2.svg

Lines changed: 14 additions & 28 deletions
Loading

0 commit comments

Comments
 (0)