Skip to content

Commit f34b22e

Browse files
committed
Some documentation cleanup, will require more.
1 parent ecb4398 commit f34b22e

File tree

2 files changed

+8
-17
lines changed

2 files changed

+8
-17
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This library is loosely based upon the [official GO client](https://github.com/h
1111
|PHPConsulAPI Version|Consul Version|
1212
|---|---|
1313
|0.3.x|0.6.4|
14-
|dev-master|0.7.0|
14+
|0.4.x|0.7.x|
1515

1616
## Composer
1717

@@ -22,7 +22,7 @@ Require Entry:
2222
```json
2323
{
2424
"require": {
25-
"dcarbone/php-consul-api": "dev-master"
25+
"dcarbone/php-consul-api": "@stable"
2626
}
2727
}
2828
```
@@ -94,8 +94,8 @@ Next, construct a [Consul](./src/Consul.php) object:
9494
$consul = new \DCarbone\PHPConsulAPI\Consul($config);
9595
```
9696

97-
*NOTE*: If you do not create your own config object, [Consul](./src/Consul.php#L59) will create it's own
98-
using [Config::newDefaultConfig()](./src/Config.php#L142).
97+
*NOTE*: If you do not create your own config object, [Consul](./src/Consul.php#L72) will create it's own
98+
using [Config::newDefaultConfig()](./src/Config.php#L145) and attempt to locate a suitable HTTP Client.
9999

100100
Once constructed, you interact with each Consul API via it's corresponding Client class:
101101

docs/LOGGING.md

+4-13
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,12 @@ Logging is handled with the [Logger](../src/Logger.php) class. To register a ne
44
[PSR-3](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md) compliant and implement
55
the [Psr\LoggerInterface](https://github.com/php-fig/log/blob/master/Psr/Log/LoggerInterface.php ) interface.
66

7-
## Provided Loggers
7+
## Debug Logger
88

9-
There are a few Logger classes provided by this lib:
9+
There is a single logger provided, the [FileDebugLogger](../src/FileDebugLogger.php)
1010

11-
- [FileLogger](../src/FileLogger.php)
12-
- [PHPLogger](../src/PHPLogger.php)
13-
- [SocketLogger](../src/SocketLogger.php)
14-
15-
## Default Logger
16-
17-
For quick and lazy debugging or the like, you may optionally call [Logger::addDefaultLogger](../src/Logger.php#L73).
18-
This creates a new [FileLogger](../src/FileLogger.php) that writes to `var/logs/php-consul-api.log`.
11+
To enable this logger, execute [Logger::addDebugLogger()](../src/Logger.php#L52)
1912

2013
## Adding Loggers
2114

22-
You may add a logger by calling [Logger::addLogger](../src/Logger.php#L112)
23-
24-
##
15+
You may add a logger by calling [Logger::addLogger](../src/Logger.php#L90)

0 commit comments

Comments
 (0)