Skip to content

Commit 1cb67e8

Browse files
committed
Update the README to match current progress.
1 parent 28ef1fe commit 1cb67e8

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
# clj-libssh2
22

3-
A Clojure wrapper around [libssh2](http://www.libssh2.org/). There are two
4-
parts to this library. The first is a
5-
[JNA](https://github.com/Chouser/clojure-jna) wrap of all of the functions and
6-
constants in the public API of libssh2. The second is a series of convenience
7-
functions designed to make this library a suitable replacement for
8-
[clj-ssh](https://github.com/hugoduncan/clj-ssh).
3+
A Clojure wrapper around [libssh2](http://www.libssh2.org/). There are three
4+
parts to this library:
5+
6+
1. A small API for doing most common SSH and SCP operations. You should use
7+
this for all new code using this library.
8+
2. A [JNA](https://github.com/Chouser/clojure-jna) wrap of all of the
9+
functions and constants in the public API of libssh2. You should use this
10+
if you need to do something unusual. Please file an issue or PR with
11+
details of what you end up using this for, so that I can expand the main
12+
API.
13+
3. A series of convenience functions designed to make this library a suitable
14+
replacement for [clj-ssh](https://github.com/hugoduncan/clj-ssh). You
15+
should use this if you're transitioning code from `clj-ssh` to this
16+
library.
17+
18+
## clj-libssh2 API
19+
20+
TODO: Examples
921

1022
## libssh2 API
1123

0 commit comments

Comments
 (0)