# poparazzi-private-api     ### An open source implementation of the Poparazzi Web API, written in TypeScript. #### Join our Discord community server via this [invite link](https://discord.gg/ywvvGuBKxT).
# Installation Installing using _NPM_ ``` npm install poparazzi-private-api ``` Installing using _Yarn_ ``` yarn add poparazzi-private-api ``` # Getting Started Take a look at examples for using the package [here.](examples/) Below is the simplest and fastest way to authenticate to Poparazzi using the package. ```typescript import * as Poparazzi from 'poparazzi-private-api'; ;(async () => { // Run the built-in terminal login prompt const client = new Poparazzi.Client({ interactive_login: true }); client.set_event({ login_success: async () => { console.log(`Logged into Poparazzi!`); await client.end_session(); // Logout from Poparazzi }}); client.set_event({ logout: async () => { console.log("Logged out of Poparazzi."); }}); })(); ``` # Documentation For more detailed information on all the package features, please see the package [docs](docs/README.md). Every single enum, interface, class object and methods are fully documented there. # Contributing If you would like to implement a new feature or fix a bug, feel free to create a pull request! API and SDK documentation also make very useful contributions, so if you are good at - please do so! Before starting on your own contribution, please read the [contributor guidelines](CONTRIBUTING.md)!
``` Released under the Apache-2.0 license. Copyright (c) 2022 Max Rodriguez ```