Skip to content

docs: document environment configurations and setup guide in README #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KGFCH2 wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −1
Open

docs: document environment configurations and setup guide in README #91

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,14 @@ https://cybershield-url.netlify.app
This project uses:

* Google Safe Browsing API

* Detects malicious URLs
* Requires API key from Google Cloud Console
* **To generate your API Key**:
1. Go to the [Google Cloud Console](https://console.cloud.google.com/).
2. Create or select a project.
3. Enable the **Safe Browsing API**.
4. Go to **APIs & Services > Credentials** and generate an API key.
5. Save the key in your local `.env` configuration file.

---

Expand Down