Skip to content

Commit 30040a7

Browse files
committed
Updated Docs for Libraries
1 parent 3136577 commit 30040a7

File tree

2 files changed

+11
-35
lines changed

2 files changed

+11
-35
lines changed

client/README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# scionftp
1+
# scionftp client
22

3-
Client package for FTP + GridFTP extension, adapted to the SCION network
3+
Client package for FTP + GridFTP extension, adapted to the SCION network.
4+
Forked from [jlaffaye/ftp](https://github.com/jlaffaye/ftp).
45

56
## Example ##
67

server/README.md

+8-33
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,25 @@
1-
# server
1+
# scionftp server
22

3-
[![Build Status](https://drone.gitea.com/api/badges/goftp/server/status.svg)](https://drone.gitea.com/goftp/server) [![](http://gocover.io/_badge/gitea.com/goftp/server)](http://gocover.io/gitea.com/goftp/server)
4-
[![](https://goreportcard.com/badge/gitea.com/goftp/server)](https://goreportcard.com/report/gitea.com/goftp/server)
5-
6-
A FTP server framework forked from [github.com/yob/graval](http://github.com/yob/graval) and changed a lot.
7-
8-
Full documentation for the package is available on [godoc](http://godoc.org/goftp.io/server)
9-
10-
## Version
11-
12-
v0.2.3
13-
14-
## Installation
15-
16-
go get goftp.io/server
3+
Server package for FTP + GridFTP extension, adapted to the SCION network.
4+
Forked from [goftp/server](https://gitea.com/goftp/server).
175

186
## Usage
197

208
To boot a FTP server you will need to provide a driver that speaks to
219
your persistence layer - the required driver contract is in [the
22-
documentation](http://godoc.org/goftp.io/server).
10+
documentation](https://godoc.org/github.com/elwin/ScionFTP/server#Driver).
2311

24-
Look at the [file driver](https://gitea.com/goftp/file-driver) to see
12+
Look at the [file driver](../file-driver) to see
2513
an example of how to build a backend.
2614

27-
There is a [sample ftp server](/exampleftpd) as a demo. You can build it with this
15+
There is a [sample ftp server](scionftp_server) as a demo. You can build it with this
2816
command:
2917

30-
go install goftp.io/server/exampleftpd
18+
go install github.com/elwin/scionFTP/server/scionftp_server
3119

3220
Then run it if you have add $GOPATH to your $PATH:
3321

34-
exampleftpd -root /tmp
22+
scionftp_server -root /tmp
3523

3624
And finally, connect to the server with any FTP client and the following
3725
details:
@@ -43,19 +31,6 @@ details:
4331

4432
This uses the file driver mentioned above to serve files.
4533

46-
## Contributors
47-
48-
see [https://gitea.com/goftp/server/graphs/contributors](https://gitea.com/goftp/server/graphs/contributors)
49-
50-
## Warning
51-
52-
FTP is an incredibly insecure protocol. Be careful about forcing users to authenticate
53-
with an username or password that are important.
54-
55-
## License
56-
57-
This library is distributed under the terms of the MIT License. See the included file for
58-
more detail.
5934

6035
## Contributing
6136

0 commit comments

Comments
 (0)