Skip to content

Commit 59fda6b

Browse files
committed
README.rst -> README.md (2)
1 parent fab46e7 commit 59fda6b

File tree

1 file changed

+14
-25
lines changed

1 file changed

+14
-25
lines changed

README.md

Lines changed: 14 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,39 @@
1-
2-
Itertools
3-
=========
1+
# Itertools
42

53
Extra iterator adaptors, functions and macros.
64

7-
Please read the `API documentation here`__
8-
9-
__ https://docs.rs/itertools/
10-
11-
|build_status|_ |crates|_
5+
Please read the [API documentation here](https://docs.rs/itertools/)
126

13-
.. |build_status| image:: https://travis-ci.org/rust-itertools/itertools.svg?branch=master
14-
.. _build_status: https://travis-ci.org/rust-itertools/itertools
15-
16-
.. |crates| image:: https://meritbadge.herokuapp.com/itertools
17-
.. _crates: https://crates.io/crates/itertools
7+
[![build_status](https://travis-ci.org/rust-itertools/itertools.svg?branch=master)](https://travis-ci.org/rust-itertools/itertools)
8+
[crates.io](https://crates.io/crates/itertools)
189

1910
How to use with cargo:
2011

21-
.. code:: toml
22-
23-
[dependencies]
24-
itertools = "0.10.0"
12+
```
13+
[dependencies]
14+
itertools = "0.10.0"
15+
```
2516

2617
How to use in your crate:
2718

28-
.. code:: rust
29-
30-
use itertools::Itertools;
19+
```
20+
use itertools::Itertools;
21+
```
3122

32-
How to contribute
33-
-----------------
23+
## How to contribute
3424

3525
- Fix a bug or implement a new thing
3626
- Include tests for your new feature, preferably a quickcheck test
3727
- Make a Pull Request
3828

39-
For new features, please first consider filing a PR to `rust-lang/rust <https://github.com/rust-lang/rust>`_,
29+
For new features, please first consider filing a PR to [rust-lang/rust](https://github.com/rust-lang/rust),
4030
adding your new feature to the `Iterator` trait of the standard library, if you believe it is reasonable.
4131
If it isn't accepted there, proposing it for inclusion in ``itertools`` is a good idea.
4232
The reason for doing is this is so that we avoid future breakage as with ``.flatten()``.
4333
However, if your feature involves heap allocation, such as storing elements in a ``Vec<T>``,
4434
then it can't be accepted into ``libcore``, and you should propose it for ``itertools`` directly instead.
4535

46-
License
47-
-------
36+
## License
4837

4938
Dual-licensed to be compatible with the Rust project.
5039

0 commit comments

Comments
 (0)