Adds screenshots as an example

This commit is contained in:
Alicia Sykes 2023-08-26 21:06:17 +01:00
parent b68447ed60
commit 54dc70e6b2
5 changed files with 3 additions and 2 deletions

4
.github/README.md vendored
View File

@ -48,6 +48,8 @@ The aim is to help you easily understand, optimize and secure your website.
</details>
[![Screenshot](https://i.ibb.co/r0jXN6s/web-check.png)](https://github.com/Lissy93/web-check/tree/master/.github/screenshots)
### Live Demo
A hosted version can be accessed at: **[web-check.as93.net](https://web-check.as93.net)**
@ -783,8 +785,6 @@ But there are some optional environmental variables that you can set to give you
Note that keys that are prefixed with `REACT_APP_` are used client-side, and as such they must be scoped correctly with minimum privileges.
# Configuration settings
**API Keys & Credentials**:
- `GOOGLE_CLOUD_API_KEY` - A Google API key ([get here](https://cloud.google.com/api-gateway/docs/authenticate-api-keys)). This can be used to return quality metrics for a site
- `REACT_APP_SHODAN_API_KEY` - A Shodan API key ([get here](https://account.shodan.io/)). This will show associated host names for a given domain

1
.github/screenshots/README.md vendored Normal file
View File

@ -0,0 +1 @@
[Screenshot](https://raw.githubusercontent.com/Lissy93/web-check/HEAD/.github/screenshots/web-check-screenshot2.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 810 KiB