-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
9 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,33 @@ | ||
# School Email Verifier | ||
This is a handy tool to verify whether an email is from a primary or secondary school that is recognised by a government | ||
institution (currently only includes schools from Ireland, England, ans Scotland). | ||
institution (currently only includes schools from the Republic of Ireland, England, and Scotland). | ||
|
||
## Installation | ||
|
||
*Note: this project uses Deno and will not run with Node.js* | ||
|
||
Installation is simple, all you have to do is clone this repo into your working directory: | ||
|
||
````commandline | ||
```sh | ||
git clone https://github.com/CragglesG/school-emails | ||
```` | ||
``` | ||
|
||
All done! You can now import the ``verifyEmail`` function into your JavaScript program. | ||
All done! You can now import the `verifyEmail` function into your JavaScript program. | ||
|
||
## Usage Guide | ||
|
||
Using ``verifyEmail`` is super easy, all you have to do is import it and call it with an email. You can import | ||
it from the ``school-emails`` directory which you cloned into: | ||
Using `verifyEmail` is super easy, all you have to do is import it and call it with an email. You can import | ||
it from the `school-emails` directory which you cloned into: | ||
|
||
```javascript | ||
import verifyEmail from './school-emails/verify_email.js' | ||
``` | ||
|
||
Now you can call the function to verify an email: | ||
|
||
````javascript | ||
```javascript | ||
verifyEmail("[email protected]") | ||
```` | ||
``` | ||
|
||
The ``verifyEmail`` function will either return the country that the school is located in or simply ``Fail`` if the | ||
The `verifyEmail` function will either return the country that the school is located in or simply `Fail` if the | ||
email does not belong to a recognised school. |