Skip to content

Commit 091dff2

Browse files
author
Jim Porter
committed
Clean up the README a bit
1 parent 0fab6b2 commit 091dff2

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ copy `include/bencode.hpp` to your destination of choice.
3535

3636
### Data types
3737

38-
Bencode has four data types: `integer`s, `string`s, `list`s, and `dict`s. These
38+
Bencode has four data types: `integer`, `string`, `list`s, and `dict`. These
3939
correspond to `long long`, `std::string`, `std::vector<bencode::data>`, and
4040
`std::map<std::string, bencode::data>`, respectively. Since the data types are
4141
determined at runtime, these are all stored in a variant type called `data`.
@@ -56,7 +56,7 @@ auto value = boost::get<bencode::integer>(data);
5656
auto data = bencode::decode(foo.begin(), foo.end());
5757
```
5858

59-
Finally, you pass an `std::istream` directly to `decode`. By default, this
59+
Finally, you can pass an `std::istream` directly to `decode`. By default, this
6060
overload will set the eof bit on the stream if it reaches the end. However, you
6161
can override this behavior. This is useful if, for instance, you're reading
6262
multiple bencoded messages from a pipe:
@@ -102,7 +102,7 @@ bencode::encode(std::cout, bencode::dict{
102102
});
103103
```
104104

105-
As with encoding, you can use the `_view` types if you know the underlying
105+
As with encoding, you can use the `*_view` types if you know the underlying
106106
memory will live until the encoding function returns.
107107

108108
## License

0 commit comments

Comments
 (0)