@cef-ebsi/cli 1.0.0-alpha.6 → 1.0.0

package/README.md

@@ -1,95 +1,96 @@
-![EBSI Logo](https://ec.europa.eu/cefdigital/wiki/images/logo/default-space-logo.svg)
-
-# EBSI Command Line Interface
-
-The EBSI CLI is a Command Line Interface to connect and test some of the EBSI Core Services provided on the European Blockchain Service Infrastructure (EBSI).
-
-**IMPORTANT REMARKS:** 
-- EBSI CLI is a sample code to help Early Adopters (EA), this is not perfect code (nor audited code) but we share it in beta version to help EA better understanding through real User Code, how to consume EBSI Core Services.
-
-- For optimal stability, we highly recommend to use the [**Node.js version 20.12**](https://nodejs.org/en/download).
-
-## Start the tool
-
-You can start the tool by running:
-
-```sh
-npx @cef-ebsi/cli
-```
-
-When the CLI prompts `==>` it will be ready to receive commands. There is no need to install the package. It needs NodeJS v18 or superior version as a prerequisite.
-
-## Documentation
-
-For more details about the use of this tool see the full documentation in https://hub.ebsi.eu/tools/cli
-
-## Publishing
-
-### From main branch
-
-Create `chore/release` branch off `main` and run the following command to bump version and update change log:
-
-```
-yarn prepare:release
-```
-
-In the case of a major release run:
-
-```
-yarn prepare:release major
-```
-
-Push the changes including the tag:
-
-```
-git push
-git push --tags
-```
-
-Create a PR on Bitbucket and merge it **without squashing it!**
-
-Then, from the updated `main` run:
-
-```
-npm publish
-```
-
-### From upcoming branch
-
-Create `chore/release` branch off `upcoming` and run the following command to bump version and update change log:
-
-```
-yarn prepare:release --preRelease=alpha
-```
-
-In the case of a major release run:
-
-```
-yarn prepare:release major --preRelease=alpha
-```
-
-Push the changes including the tag:
-
-```
-git push
-git push --tags
-```
-
-Create a PR on Bitbucket and merge it **without squashing it!**
-
-Then, from the updated `upcoming` run:
-
-```
-npm publish --tag upcoming
-```
-
-## License <a name="license"></a>
-
-Copyright (c) 2019 European Commission
-Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European Commission - subsequent versions of the EUPL (the "Licence");
-You may not use this work except in compliance with the Licence.
-You may obtain a copy of the Licence at:
-
-- <https://joinup.ec.europa.eu/page/eupl-text-11-12>
-
-Unless required by applicable law or agreed to in writing, software distributed under the Licence is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licence for the specific language governing permissions and limitations under the Licence.
+![EBSI Logo](https://ec.europa.eu/cefdigital/wiki/images/logo/default-space-logo.svg)
+
+# EBSI Command Line Interface
+
+The EBSI CLI is a Command Line Interface to connect and test some of the EBSI Core Services provided on the European Blockchain Service Infrastructure (EBSI).
+
+**IMPORTANT REMARKS:**
+
+- EBSI CLI is a sample code to help Early Adopters (EA), this is not perfect code (nor audited code) but we share it in beta version to help EA better understanding through real User Code, how to consume EBSI Core Services.
+
+- For optimal stability, we highly recommend to use the [**Node.js version 20.12**](https://nodejs.org/en/download).
+
+## Start the tool
+
+You can start the tool by running:
+
+```sh
+npx @cef-ebsi/cli
+```
+
+When the CLI prompts `==>` it will be ready to receive commands. There is no need to install the package. It needs NodeJS v18 or superior version as a prerequisite.
+
+## Documentation
+
+For more details about the use of this tool see the full documentation in https://hub.ebsi.eu/tools/cli
+
+## Publishing
+
+### From main branch
+
+Create `chore/release` branch off `main` and run the following command to bump version and update change log:
+
+```
+yarn prepare:release
+```
+
+In the case of a major release run:
+
+```
+yarn prepare:release major
+```
+
+Push the changes including the tag:
+
+```
+git push
+git push --tags
+```
+
+Create a PR on Bitbucket and merge it **without squashing it!**
+
+Then, from the updated `main` run:
+
+```
+npm publish
+```
+
+### From upcoming branch
+
+Create `chore/release` branch off `upcoming` and run the following command to bump version and update change log:
+
+```
+yarn prepare:release --preRelease=alpha
+```
+
+In the case of a major release run:
+
+```
+yarn prepare:release major --preRelease=alpha
+```
+
+Push the changes including the tag:
+
+```
+git push
+git push --tags
+```
+
+Create a PR on Bitbucket and merge it **without squashing it!**
+
+Then, from the updated `upcoming` run:
+
+```
+npm publish --tag upcoming
+```
+
+## License <a name="license"></a>
+
+Copyright (c) 2019 European Commission
+Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European Commission - subsequent versions of the EUPL (the "Licence");
+You may not use this work except in compliance with the Licence.
+You may obtain a copy of the Licence at:
+
+- <https://joinup.ec.europa.eu/page/eupl-text-11-12>
+
+Unless required by applicable law or agreed to in writing, software distributed under the Licence is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licence for the specific language governing permissions and limitations under the Licence.