Update implementation-details.md

anand768 · Mar 20, 2020 · cb7022e · cb7022e
1 parent b94f6a1
commit cb7022e
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/packages/artifact/docs/implementation-details.md b/packages/artifact/docs/implementation-details.md
@@ -1,5 +1,11 @@
 # Implementation Details
 
+Warning: Implementation details may change at any time without notice. This is meant to serve as a reference to help users understand the package.
+
+## Upload/Compression flow
+
+![image](https://user-images.githubusercontent.com/16109154/77190819-38685d80-6ada-11ea-8281-4703ff8cc025.png)
+
 ## Proxy support
 
 This package uses the `@actions/http-client` NPM package internally which supports proxied requests out of the box. 
@@ -40,4 +46,4 @@ TCP connections consist of an input and output buffer to manage what is sent and
 
 ### Non Concurrent calls
 
-Both `upload-http-client` and `download-http-client` do not instantiate or create any HTTP clients (the `HttpManager` has that responsibility). If an HTTP call has to be made that does not require the `keep-alive` header (such as when calling `listArtifacts` or `patchArtifactSize`), the first `HttpClient` in the `HttpManager` is used. The number of available clients is equal to the upload or download concurrency and there will always be at least one available.
+Both `upload-http-client` and `download-http-client` do not instantiate or create any HTTP clients (the `HttpManager` has that responsibility). If an HTTP call has to be made that does not require the `keep-alive` header (such as when calling `listArtifacts` or `patchArtifactSize`), the first `HttpClient` in the `HttpManager` is used. The number of available clients is equal to the upload or download concurrency and there will always be at least one available.