commit 5cc58661b9d9b5a780b36eb1aae1971304a8612a
parent bcf5b82b97afd410ee0ef87e1a4421af46e8c699
Author: Michael Savage <mikejsavage@gmail.com>
Date: Thu, 24 Aug 2017 18:24:38 +0100
More README updates
Diffstat:
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -19,8 +19,6 @@ streams under the hood and also bloats compile times.
## Usage
-The formatting API looks like this:
-
```
size_t ggformat( char * buf, size_t len, const char * fmt, ... );
bool ggprint_to_file( FILE * file, const char * fmt, ... );
@@ -31,6 +29,7 @@ bool ggprint( const char * fmt, ... );
a null terminator. Its return value is the number of bytes that would
have been written if `buf` were large enough, _not including the null
terminator_, and can be larger than `len` (just like sprintf).
+
`ggprint_to_file` does what you would expect, and `ggprint` writes to
standard output. Both return `true` on success, or `false` if the write
fails.
