Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CragglesG authored Nov 16, 2024
1 parent 948c086 commit 95ef4d8
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
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.

0 comments on commit 95ef4d8

Please sign in to comment.