Added examples readme

This commit is contained in:
Alex Corn 2023-06-23 01:02:20 -04:00
parent 5f46aee9fc
commit 7605dc8a41
No known key found for this signature in database
GPG Key ID: E51989A3E7A27FDF

19
examples/README.md Normal file
View File

@ -0,0 +1,19 @@
# node-steamcommunity examples
The files in this directory are example scripts that you can use as a getting-started point for using node-steamcommunity.
## Enable or Disable Two-Factor Authentication
If you need to enable or disable 2FA on your bot account, you can use enable_twofactor.js and disable_twofactor.js to do so.
The way that you're intended to use this scripts is by cloning the repository locally, and then running them directly
from this examples directory.
For example:
```shell
git clone https://github.com/DoctorMcKay/node-steamcommunity node-steamcommunity
cd node-steamcommunity
npm install
cd examples
node enable_twofactor.js
```