Skip to content

Commit 455c387

Browse files
committed
Update README
1 parent 8a27faf commit 455c387

File tree

2 files changed

+24
-2
lines changed

2 files changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,30 @@
1-
# devdocs-macos
1+
# DevDocs for macOS
22

33
An unofficial [DevDocs API Documentation][1] viewer for macOS.
44

5+
![App screenshot](./img/screenshot.png?raw=true "DevDocs for macOS screenshot")
6+
7+
## Features
8+
9+
- [x] Tabs
10+
- [x] Global Shortcut (Option + Space)
11+
- [x] Automatic Dark/Light mode
12+
13+
## Download & Install
14+
15+
Pre-built binaries can be downloaded from the [releases page][2].
16+
17+
### Compatibility
18+
19+
The app is currently developed on Mojave and only support for Mojave can be
20+
provided.
21+
522
## License
623

7-
Copyright (C) 2018 Douglas Teoh
24+
```
25+
devdocs-macos
26+
27+
Copyright (C) 2018 Douglas Teoh
828
929
This program is free software: you can redistribute it and/or modify
1030
it under the terms of the GNU General Public License as published by
@@ -18,5 +38,7 @@ GNU General Public License for more details.
1838
1939
You should have received a copy of the GNU General Public License
2040
along with this program. If not, see <https://www.gnu.org/licenses/>.
41+
```
2142

2243
[1]: https://devdocs.io/
44+
[2]: https://github.com/dteoh/devdocs-macos

img/screenshot.png

611 KB
Loading

0 commit comments

Comments
 (0)