aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKumar Priyansh <[email protected]>2019-06-19 15:22:19 +0530
committerKumar Priyansh <[email protected]>2019-06-19 15:22:19 +0530
commit4820cc2ca9897534b6fb8b17d3218554988ae5ff (patch)
tree667e5a9d7518d1eb232645abda30ca2f344c8546
parent1e6fcc41a8d962b6d87b01bc2f9b767ea8679d0c (diff)
downloadauthorr-4820cc2ca9897534b6fb8b17d3218554988ae5ff.tar.xz
authorr-4820cc2ca9897534b6fb8b17d3218554988ae5ff.zip
Who doesn't want a good Readme?
-rw-r--r--README.md19
-rw-r--r--docs/extras/notav.pngbin0 -> 30293 bytes
-rw-r--r--docs/extras/runsonmac.pngbin0 -> 213923 bytes
3 files changed, 17 insertions, 2 deletions
diff --git a/README.md b/README.md
index 73731df..a6ecc79 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,9 @@ A desktop app for authors.
#### An Original Project By Kumar Priyansh
+<img src="docs/extras/runsonmac.png" height="70px"><br>
+<img src="docs/extras/notav.png" width="160px">
+
## For Developers:
- ### Cloning:
@@ -14,6 +17,18 @@ A desktop app for authors.
git clone https://github.com/luciferreeves/authorr
````
- ### Dependencies:
- ````
+ ````
+ "dependencies": {
+ "jquery": "^3.4.1",
+ "local-storage": "^2.0.0"
+ }
+
+ "devDependencies": {
+ "electron": "^5.0.3",
+ "@fortawesome/fontawesome-free": "^5.9.0",
+ "electron-builder": "^20.43.0"
+ }
+ ````
+- ### How to get started on macOS:
- ```` \ No newline at end of file
+ npm install && npm start
diff --git a/docs/extras/notav.png b/docs/extras/notav.png
new file mode 100644
index 0000000..df373ac
--- /dev/null
+++ b/docs/extras/notav.png
Binary files differ
diff --git a/docs/extras/runsonmac.png b/docs/extras/runsonmac.png
new file mode 100644
index 0000000..357bccc
--- /dev/null
+++ b/docs/extras/runsonmac.png
Binary files differ