SquashScrape

Get your latest game data.

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License

About The Project

This tool will enable SquashLevels users to grab their latests game data and export it to JSON or CSV.

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

You will need to have a squashlevels account.

Installation

1. Install package

   npm i squashscrape

2. create .env file SQUASHLEVELS_USER, SQUASHLEVELS_PASSWORD_MD5

3. import the package

   import * as squashscrape from 'squashscrape'

4. collect data

   squashscrape.dataToCsv(); Will generate a CSV
   squashscrape.dataToJson(); Will generate a JSON
   squashscrape.collectData(); Will return an object

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

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

(back to top)