瀏覽代碼

NuGet README.md + Updating description according to wiki

Source commit: 94886e6826437cb18a472410c699830bce5b370e
Martin Prikryl 2 年之前
父節點
當前提交
699219ca2e
共有 2 個文件被更改,包括 13 次插入1 次删除
  1. 3 1
      deployment/WinSCPnet.nuspec
  2. 10 0
      deployment/readme_nuget.md

+ 3 - 1
deployment/WinSCPnet.nuspec

@@ -11,9 +11,10 @@
     <icon>winscp64.png</icon>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <summary>The WinSCP .NET assembly is a .NET wrapper around WinSCP’s scripting interface.</summary>
+    <readme>docs\README.md</readme>
     <description>The WinSCP .NET assembly is a .NET wrapper around WinSCP’s scripting interface that allows your code to connect to a remote machine and manipulate remote files over SFTP, FTP, WebDAV, S3 and SCP sessions.
 
-The library is primarily intended for advanced automation tasks that require conditional processing, loops or other control structures for which the basic scripting interface is too limited. The library is not a general purpose file transfer library. It particularly has a limited support for an interactive processing, and as such it is not well suited for use in GUI applications. For the same reason it is also difficult to use the assembly within a restricted environment like a web server, that limits or even restricts execution of external processes.
+The library is primarily intended for advanced automation tasks on Microsoft Windows that require conditional processing, loops or other control structures for which the basic scripting interface is too limited. The library is not a general purpose file transfer library. It particularly has a limited support for an interactive processing, and as such it is not well suited for use in GUI applications. For the same reason it is also difficult to use the assembly within a restricted environment like a web server, that limits or even restricts execution of external processes.
 
 For documentation and examples of use, see project website.
 
@@ -32,5 +33,6 @@ The NuGet package includes the assembly itself and a required WinSCP executable.
     <file src="WinSCP.targets" target="build"/>
     <file src="WinSCP.targets" target="buildTransitive"/>
     <file src="winscp64.png" target=""/>
+    <file src="README.md" target="docs"/>
   </files>
 </package>

+ 10 - 0
deployment/readme_nuget.md

@@ -0,0 +1,10 @@
+The WinSCP .NET assembly is a .NET wrapper around WinSCP’s scripting interface that allows your code to connect to a remote machine and manipulate remote files over SFTP, FTP, WebDAV, S3 and SCP sessions.
+
+The library is primarily intended for advanced automation tasks on Microsoft Windows that require conditional processing, loops or other control structures for which the basic scripting interface is too limited. The library is not a general purpose file transfer library. It particularly has a limited support for an interactive processing, and as such it is not well suited for use in GUI applications. For the same reason it is also difficult to use the assembly within a restricted environment like a web server, that limits or even restricts execution of external processes.
+
+The NuGet package includes the assembly itself and a required WinSCP executable. When installed, it adds the assembly as reference to your project and sets up WinSCP executable to be copied to project output directory, so that it can be found on run-time.
+
+For more information, visit WinSCP website:
+
+* [Documentation](https://winscp.net/eng/docs/library)
+* [Examples](https://winscp.net/eng/docs/library_examples)