Skip to content

Commit

Permalink
Update read me with more info on the .ini file
Browse files Browse the repository at this point in the history
  • Loading branch information
dutchie027 authored Nov 10, 2022
1 parent 4d6a180 commit 10a01fe
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,29 @@ $api = new dutchie027\Vultr\API();
...
```
### vultr.ini
This file will be created when you donload the library using composer. If you don't generate one at initial load/run time with composer
simply have the minimum Key/Value Pair in the `[api]` key with the `TOKEN` being your API token from the My Vultr Portal.
This file drives the main configuration of the software. By default, it looks for the file in the root directory of your project using the name vultr.ini. If you want, you can give it another name and specifiy the full .ini path in the class instantiation.

The minimum Key/Value Pair in the `[api]` key with the `TOKEN` being your API token from the My Vultr Portal.

```ini
# minimum vultr.ini
[api]
TOKEN='8675309TOMMY30918IN'
```

The full settings that can be supplied in the .ini are:

```ini
# full vultr.ini
[api]
TOKEN='12345
[log]
LOG_PREFIX='vultr'
LOG_LEVEL=200
LOG_DIR='/var/log/'
```
## General Information
### Class Listing
Expand Down

0 comments on commit 10a01fe

Please sign in to comment.