Skip to content
This repository was archived by the owner on Aug 26, 2025. It is now read-only.

Commit e4b7020

Browse files
author
Martin Wentzel
committed
Enhance README.
1 parent 6c115c0 commit e4b7020

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,16 @@ Possible options for `forwardOptions`:
111111

112112
Closes all connections.
113113

114+
## Developing
115+
116+
* Add your wanted feature to the implementation in `./src`
117+
* Add test in `./test/test.ts`
118+
* Run the test with `./test/test.sh`
119+
114120
## Limitations/Todos
115121

116122
* only works with username , private key and ssh agent
117123
* host based authentication
118-
* No tests
119124
* Better documentation
120125
* Debug logging
121126
* Ability to pass an additional string to the `forward` that specifies when the promise is resolved and the forwarding is stopped

0 commit comments

Comments
 (0)