Skip to content

Commit da21729

Browse files
committed
docs(README): Remove unused part, note features, link quickstart
1 parent 6dddc56 commit da21729

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed

README.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,18 @@ libvcs is a lite, [typed](https://docs.python.org/3/library/typing.html), python
44
detection and parsing of URLs, commanding, and syncing with `git`, `hg`, and `svn`. Powers
55
[vcspull](https://www.github.com/vcs-python/vcspull/).
66

7-
## Setup
7+
## Overview
88

9-
```console
10-
$ pip install --user libvcs
11-
```
12-
13-
Open up python:
14-
15-
```console
16-
$ python
17-
```
9+
Features for git, Subversion, and Mercurial:
1810

19-
Or for nice autocompletion and highlighting:
11+
- **Detect and parse** VCS URLs
12+
- **Command** VCS via python API
13+
- **Sync** repos locally
2014

21-
```console
22-
$ pip install --user ptpython
23-
```
15+
To **get started**, see the [quickstart](https://libvcs.git-pull.com/quickstart.html) for more.
2416

2517
```console
26-
$ ptpython
18+
$ pip install --user libvcs
2719
```
2820

2921
## URL Parsing (experimental)

0 commit comments

Comments
 (0)