Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

coming soon...

(back to top)

Built With

• 
• 

(back to top)

Getting Started

Installation

1. Install NPM package

   1npm i caniemail-fetcher

(back to top)

Usage

1import { CanIEmailFetcher } from 'caniemail-fetcher';
2
3// Optional settings
4const options = {
5    githubToken: 'YOUR_GITHUB_TOKEN', // Optional, removes GitHub API rate limit
6    updateInterval: 12, // Optional, interval to check for updates in hours, default is 24
7};
8
9const fetcher = new CanIEmailFetcher(options);
10
11// Update Listener
12const updateListener = (data) => {
13    console.log('Update event received', data);
14};
15
16// Listen for updates
17fetcher.onUpdate(updateListener);
18
19// Stop listening for updates
20fetcher.offUpdate(updateListener);

(back to top)

Top contributors:

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/FabianKrup/caniemail-fetcher

(back to top)

Acknowledgments

This project makes extensive use of the data provided by the Can I email… project. We are deeply grateful for their hard work and dedication to improving email standards and compatibility across different platforms. Their project serves as the foundation upon which our tool builds to provide up-to-date email client compatibility information.

(back to top)