aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md17
-rw-r--r--screenshot.pngbin0 -> 1544655 bytes
2 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index eb9ed53..b46aa0c 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,24 @@
# [Aurora-data](https://jakobst1n.github.io/Aurora-data/)
+
+![Image of current design](https://github.com/JakobST1n/Aurora-data/blob/master/screenshot.png)
This is very much a work in progress, the idea is to collect all the information you would want when
hunting for northern lights. In a Progressive web app, which polls all API's directly from your device.
-# Credits
+## Credits
- All data related to space weather is from [USA National Space Weather Prediction Center](https://www.swpc.noaa.gov).
- All weather data is from [MET Norway](https://met.no).
- Background photo by [Jonatan Pie](https://unsplash.com/@r3dmax?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText) on [Unsplash](https://unsplash.com/s/photos/northern-lights?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText).
- Location name is pulled from [geocode](https://geocode.xyz/api).
+
+## Usage
+To use the app in its current state, go [here](https://jakobst1n.github.io/Aurora-data/).
+
+
+To test it for youself or to test while coding run:
+```shell
+npm run dev
+```
+And the site will be on:
+```
+http://localhost:3000/Aurora-data
+```
diff --git a/screenshot.png b/screenshot.png
new file mode 100644
index 0000000..2a2af74
--- /dev/null
+++ b/screenshot.png
Binary files differ