Merge pull request #13 from huggingface/clearer_description

Make it clearer that the library is provided as-is and is not meant

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,41 @@
+name: "\U0001F41B Bug Report"
+description: Submit a bug report to help us improve hf_transfer
+body:
+  - type: textarea
+    id: system-info
+    attributes:
+      label: System Info
+      description: Please make sure the bug you are describing is not a general
+        usability thing. This library is provided *as-is*, not as a general
+        usability tool. Issues need to concern the actual result of the downloaded
+        or uploaded files.
+      placeholder: hf_transfer version, platform, python version, huggingface_hub version...
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    validations:
+      required: true
+    attributes:
+      label: Reproduction
+      description: |
+        Please provide a code sample that reproduces the problem you ran into. It can be a Colab link or just a code snippet.
+        If you have code snippets, error messages, stack traces please provide them here as well.
+        Important! Use code tags to correctly format your code. See https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting
+        Do not use screenshots, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code.
+
+      placeholder: |
+        Steps to reproduce the behavior:
+          
+          1.
+          2.
+          3.
+          
+
+  - type: textarea
+    id: expected-behavior
+    validations:
+      required: true
+    attributes:
+      label: Expected behavior
+      description: "A clear and concise description of what you would expect to happen."

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,2 @@
+blank_issues_enabled: true
+version: 2.1

README.md

@@ -2,7 +2,15 @@
 
 Speed up file transfers with the Hub.
 
-Supports download and upload.
+# DISCLAIMER
+
+This library is a power user tool, to go beyond `~500MB/s` on very high bandwidth
+network, where Python cannot cap out the available bandwidth.
+
+This is *not* meant to be a general usability tool.
+It purposefully lacks progressbars and comes generally as-is.
+
+Please file issues *only* if there's an issue on the underlying downloaded file.
 
 ## Contributing