diff --git a/README.md b/README.md index b2a6981..69b96e0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,57 @@ -# SSHApi +# SSHApi for Server Side Swift [简体中文](README.zh_CN.md) -libssh2 for Swift +
+ + + +
+ + + + + + + +This project is a wrapper of libssh2 in Swift. + +This package builds with Swift Package Manager and is part of the [Perfect](https://github.com/PerfectlySoft/Perfect) project and is not suggested to use as an independent module. + +## Issues + +We are transitioning to using JIRA for all bugs and support related issues, therefore the GitHub issues has been disabled. + +If you find a mistake, bug, or any other helpful suggestion you'd like to make on the docs please head over to [http://jira.perfect.org:8080/servicedesk/customer/portal/1](http://jira.perfect.org:8080/servicedesk/customer/portal/1) and raise it. + +A comprehensive list of open issues can be found at [http://jira.perfect.org:8080/projects/ISS/issues](http://jira.perfect.org:8080/projects/ISS/issues) + +## Further Information +For more information on the Perfect project, please visit [perfect.org](http://perfect.org).