docs: polish wordings

smol-ninja · Aug 13, 2024 · 5dfad70 · 5dfad70
1 parent 7dd6adb
commit 5dfad70
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -13,7 +13,7 @@ jobs:
       - name: "Check out the repo"
         uses: "actions/checkout@v4"
 
-      - name: "Verify the Solidity tests using Bulloak with quotes"
+      - name: "Install and run Bulloak"
         uses: "smol-ninja/bulloak-toolchain@main"
         with:
           tree-path: "test-workspace/**.tree"

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Bulloak Toolchain
 
-This GitHub Action installs the [Bulloak](https://github.com/alexfertel/bulloak) toolchain. Special thanks to [alexfertel](https://x.com/alexfertel) for his amazing work on Bulloak.
+This GitHub Action installs the [Bulloak](https://github.com/alexfertel/bulloak) toolchain and check that Solidity tests conform to BTT spec. Special thanks to [alexfertel](https://x.com/alexfertel) for his amazing work on Bulloak.
 
 ## Example workflow
 
@@ -19,7 +19,7 @@ jobs:
       - name: "Check out the repo"
         uses: "actions/checkout@v4"
 
-      - name: "Verify the Solidity tests using Bulloak"
+      - name: "Install and run Bulloak"
         uses: "smol-ninja/bulloak-toolchain@v1"
         with:
           skip-modifiers: "false"

diff --git a/action.yml b/action.yml
@@ -1,5 +1,5 @@
 name: bulloak-toolchain
-description: Verify that the Solidity tests match the structure of the Branching Trees.
+description: Install Bulloak and check that Solidity tests conform to BTT spec
 author: Sablier Labs Ltd
 
 branding:
@@ -71,13 +71,13 @@ runs:
         echo "bulloak-version=$(bulloak --version)" >> $GITHUB_OUTPUT
         bulloak --version
 
-    - name: Verify that the Solidity tests match the structure of the Branching Trees
+    - name: Check that the Solidity tests conform to BTT spec
       env:
         SKIP_MODIFIERS: ${{ inputs.skip-modifiers }}
         TREE_PATH: ${{ inputs.tree-path }}
       shell: bash
       run: |
-        echo "🌳 Verifying the Solidity tests using Bulloak"
+        echo "🌳 Checking the Solidity tests using Bulloak"
         if [ "$SKIP_MODIFIERS" == "true" ]; then
           bulloak check $TREE_PATH --skip-modifiers
         else