Skip to content

Commit 497f24d

Browse files
committed
docs(README): Update docs
1 parent 08a0ff2 commit 497f24d

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# `libvcs` · [![Python Package](https://img.shields.io/pypi/v/libvcs.svg)](https://pypi.org/project/libvcs/) [![License](https://img.shields.io/github/license/vcs-python/libvcs.svg)](https://github.com/vcs-python/libvcs/blob/master/LICENSE) [![Code Coverage](https://codecov.io/gh/vcs-python/libvcs/branch/master/graph/badge.svg)](https://codecov.io/gh/vcs-python/libvcs)
22

3-
libvcs is an abstraction layer for vcs systems. powers
4-
[vcspull](https://www.github.com/vcs-python/vcspull/).
3+
libvcs is a lite, [typed](https://docs.python.org/3/library/typing.html), pythonic wrapper for
4+
`git`, `hg`, and `svn`. Powers [vcspull](https://www.github.com/vcs-python/vcspull/).
55

66
## Setup
77

@@ -39,8 +39,11 @@ to inspect / checkout / update:
3939
... vcs='git',
4040
... dir='/tmp/libtmux'
4141
... )
42+
```
43+
44+
Initialize via "pip-style URLs":
4245

43-
# or via pip-style URL
46+
```python
4447
>>> r = create_repo_from_pip_url(
4548
... pip_url='git+https://www.github.com/vcs-python/libtmux',
4649
... dir='/tmp/libtmux'
@@ -50,7 +53,6 @@ to inspect / checkout / update:
5053
Update / clone repo:
5154

5255
```python
53-
# it may or may not be checked out/cloned on the system yet
5456
>>> r.update_repo()
5557
```
5658

0 commit comments

Comments
 (0)