Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Additions to the documentation #160

Merged
merged 3 commits into from

2 participants

@tUrG0n

Did two changes:

  • Fixed type in docs/transport.md
  • In Readme.md, added reference to the last sections in the table of content.
@pksunkara pksunkara merged commit 31dbaeb into winstonjs:master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Aug 1, 2012
  1. Fixed typo in docs/transports.md

    tUrG0n authored
  2. Adding last sections to the table of contents

    tUrG0n authored
This page is out of date. Refresh to see the latest.
Showing with 8 additions and 4 deletions.
  1. +7 −3 README.md
  2. +1 −1  docs/transports.md
View
10 README.md
@@ -29,7 +29,11 @@ There are two different ways to use winston: directly via the default logger, or
* [Working with multiple Loggers in winston](#working-with-multiple-loggers-in-winston)
* [Using winston in a CLI tool](#using-winston-in-a-cli-tool)
* [Extending another object with Logging](#extending-another-object-with-logging)
- * [Adding Custom Transports](#adding-custom-transports)
+* [Working with transports](#working-with-transports)
+ * [Adding Custom Transports](#adding-custom-transports)
+* [Installation](#installation)
+* [Run Tests](#run-tests)
+
## Logging
@@ -50,7 +54,7 @@ By default, only the Console transport is set on the default logger. You can add
winston.remove(winston.transports.Console);
```
-For more documenation about working with each individual transport supported by Winston see the "Working with Transports" section below.
+For more documenation about working with each individual transport supported by Winston see the [Working with transports](#working-with-transports) section below.
### Instantiating your own Logger
If you would prefer to manage the object lifetime of loggers you are free to instantiate them yourself:
@@ -507,7 +511,7 @@ Configuring output for this style is easy, just use the `.cli()` method on `wins
```
### Extending another object with Logging
-Often in a given code base with lots of Loggers it is useful to add logging methods a different object so that these methods can be called with less syntax. Winston exposes this functionality via the 'extend' method:
+Often in a given code base with lots of Loggers it is useful to add logging methods to a different object so that these methods can be called with less syntax. Winston exposes this functionality via the 'extend' method:
``` js
var myObject = {};
View
2  docs/transports.md
@@ -1,6 +1,6 @@
# Winston Transports
-In `winston` a transport a transport is essentially a storage device for your logs. Each instance of a winston logger can have multiple transports configured at different levels. For example, one may want error logs to be stored in a persistent remote location (like a database), but all logs output to the console or a local file.
+In `winston` a transport is essentially a storage device for your logs. Each instance of a winston logger can have multiple transports configured at different levels. For example, one may want error logs to be stored in a persistent remote location (like a database), but all logs output to the console or a local file.
There are several [core transports](#winston-core) included in `winston`, which leverage the built-in networking and file I/O offered by node.js core. In addition, there are [third-party transports which are supported by the winston core team](#winston-more). And last (but not least) there are [additional transports written by members of the community](#additional-transports).
Something went wrong with that request. Please try again.