Permalink
Browse files

Updated README.md with note about text encoding

  • Loading branch information...
1 parent e60efa8 commit cd6d9676a77f74a91663a3eac29bfed14338060f @asantoni committed Aug 2, 2012
Showing with 9 additions and 1 deletion.
  1. +9 −1 README.md
View
10 README.md
@@ -24,7 +24,9 @@ API at a Glance
```c++
class AudioDecoder {
- /** Construct a decoder for a given audio file. */
+ /** Construct a decoder for a given audio file.
+ @param filename A UTF-8 string containing the full path to the audio file to open.
+ */
AudioDecoder(const std::string filename);
virtual ~AudioDecoder();
@@ -137,6 +139,12 @@ API Stability Warning
libaudiodecoder was developed primarily with Windows and Mac OS X in mind. Because most application developers on these platforms build and ship their own 3rd party libraries with their products, API changes will be noticed at compile time or during testing. We make no guarantees about the stability of the API at this point, though it's not likely to change too much.
+String Encoding
+===============
+
+All strings in the API are assumed to be UTF-8 encoded.
+
+
Authors
=======

0 comments on commit cd6d967

Please sign in to comment.