Merge pull request #19 from nspcc-dev/improve-readme

Improve README
nspcc-dev · Apr 1, 2024 · 59b9b31 · 59b9b31
2 parents d5fcca4 + 118b4e4
commit 59b9b31
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -6,17 +6,16 @@
   </picture>
 </p>
 <p align="center">
-  <a href="https://fs.neo.org">NeoFS</a> is a decentralized distributed object storage integrated with the <a href="https://neo.org">NEO Blockchain</a>.
+  <a href="https://fs.neo.org">NeoFS</a> is a decentralized distributed object storage integrated with the <a href="https://neo.org">Neo blockchain</a>.
 </p>
 
 # GitHub Action to Publish to NeoFS
 This GitHub action allows you to save files as objects in the [NeoFS](https://fs.neo.org/).
 
 This way you can both publicly and privately save logs and test results, host web pages, and publish releases.
 
-[Here](https://neospcc.medium.com/neofs-t5-testnet-has-been-started-ae75c30e856b) is a good article on how to get
-started using the NeoFS testnet, this may be useful if you have no experience with NeoFS and want to get started with
-the test network.
+To use this action you need a wallet, some NeoFS balance and a container. The
+easiest way to handle deposit and container creation is via [Panel](https://panel.fs.neo.org/).
 
 ## Supported platforms
 This action supports the following platforms:
@@ -55,7 +54,7 @@ and `NEOFS_HTTP_GATE` environment variables.
 | Key                    | Value                                                                                 | Required | Default                |
 |------------------------|---------------------------------------------------------------------------------------|----------|------------------------|
 | `NEOFS_NETWORK_DOMAIN` | Rpc endpoint domain address                                                           | **No**   | st1.storage.fs.neo.org |
-| `NEOFS_HTTP_GATE`      | HTTP Gateway domain address                                                           | **No**   | http.fs.neo.org        |
+| `NEOFS_HTTP_GATE`      | REST gateway domain address                                                           | **No**   | rest.fs.neo.org        |
 | `STORE_OBJECTS_CID`    | Container ID for your data. For example: 7gHG4HB3BrpFcH9BN3KMZg6hEETx4mFP71nEoNXHFqrv | **Yes**  | N/A                    |
 
 

diff --git a/action.yml b/action.yml
@@ -16,9 +16,9 @@ inputs:
     required: false
     default: 'st1.storage.fs.neo.org'
   NEOFS_HTTP_GATE:
-    description: HTTP Gateway domain address
+    description: REST gateway domain address
     required: false
-    default: 'http.fs.neo.org'
+    default: 'rest.fs.neo.org'
   STORE_OBJECTS_CID:
     description: Container ID for your data
     required: true

diff --git a/push-to-neofs.py b/push-to-neofs.py
@@ -49,9 +49,9 @@ def parse_args():
         help="This is a prefix to the url address for each of the files(objects)."
         "For example, if Container ID is HXSaMJXk2g8C14ht8HSi7BBaiYZ1HeWh2xnWPGQCg4H6 and"
         "--url_path_prefix is '96-1697035975', then the url will be:"
-        "  https://http.fs.neo.org/HXSaMJXk2g8C14ht8HSi7BBaiYZ1HeWh2xnWPGQCg4H6/832-1695916423/file.txt"
+        "  https://rest.fs.neo.org/HXSaMJXk2g8C14ht8HSi7BBaiYZ1HeWh2xnWPGQCg4H6/832-1695916423/file.txt"
         "Without --url_path_prefix the url will be:"
-        "  https://http.fs.neo.org/HXSaMJXk2g8C14ht8HSi7BBaiYZ1HeWh2xnWPGQCg4H6/file.txt",
+        "  https://rest.fs.neo.org/HXSaMJXk2g8C14ht8HSi7BBaiYZ1HeWh2xnWPGQCg4H6/file.txt",
         nargs="?",
         const=None,
         default=None,