Skip to content

Commit

Permalink
docs: format and cross out workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
simonsan committed Mar 12, 2024
1 parent 8dd8a87 commit 4143380
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Russh SFTP

SFTP subsystem supported server and client for [Russh](https://github.com/warp-tech/russh) and more!

Crate can provide compatibility with anything that can provide the raw data stream in and out of the subsystem channel.\
Expand All @@ -7,10 +8,12 @@ Implemented according to [version 3 specifications](https://datatracker.ietf.org
The main idea of the project is to provide an implementation for interacting with the protocol at any level.

## Examples

- [Client example](https://github.com/AspectUnk/russh-sftp/blob/master/examples/client.rs)
- [Simple server](https://github.com/AspectUnk/russh-sftp/blob/master/examples/server.rs)

## What's ready?

- [x] Basic packets
- [x] Extended packets
- [x] Simplification for file attributes
Expand All @@ -21,7 +24,8 @@ The main idea of the project is to provide an implementation for interacting wit
- [x] Extension support: `limits@openssh.com`, `fsync@openssh.com`, `statvfs@openssh.com`
- [ ] Full server example
- [ ] Unit tests
- [ ] Workflow
- [x] Workflow

## Some words

Thanks to [@Eugeny](https://github.com/Eugeny) (author of the [Russh](https://github.com/warp-tech/russh)) for his prompt help and finalization of Russh API

0 comments on commit 4143380

Please sign in to comment.