Skip to content

Commit dc5e765

Browse files
committed
improve README
see #2
1 parent d8b93b9 commit dc5e765

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
A lightweight Git Large File Storage fetcher written in python
1+
A lightweight Git Large File Storage fetcher written in python.
2+
3+
This module cannot fully replace the official git-lfs client, it only knows how
4+
to download the files, cache them (the same way the official client does), and
5+
place them in a checkout directory. Uploading files is not implemented at all.
26

37
Installation
48
============
@@ -10,7 +14,9 @@ python-git-lfs is compatible with python 2 and 3.
1014
Usage
1115
=====
1216

13-
::
17+
Basic: simply run ``python -m git_lfs`` in a normal Git repository.
18+
19+
Advanced::
1420

1521
python -m git_lfs [-h] [-v] [git_repo] [checkout_dir]
1622

0 commit comments

Comments
 (0)