update

.github/workflows/build-docs.yml

@@ -10,6 +10,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '1.20'
+          check-latest: true
+          cache: false
+      - name: Generate Docs
+        run: make generate-docs
+      - name: Check nothing has changed
+        run: |
+          set -xo pipefail
+          git diff --exit-code -- .
       - uses: actions/setup-python@v4
         with:
           python-version: 3.x

.gitignore

@@ -1,3 +1,4 @@
 dist
 .idea
-.DS_Store
+.DS_Store
+site

Makefile

@@ -1,5 +1,10 @@
 .PHONY: generate-docs
 generate-docs:
 	@cp README.md docs/index.md
+ifeq ($(shell uname),Darwin)
+	@sed -i '' 's/\.\/CONTRIBUTING\.md/contributing\.md/g' docs/index.md
+else
+	@sed -i 's/\.\/CONTRIBUTING\.md/contributing\.md/g' docs/index.md
+endif
 	@cp CONTRIBUTING.md docs/contributing.md
 	@go run hack/gendocs/main.go

README.md

@@ -1,6 +1,6 @@
-# Token Security Benchmark (TSB)
+# Token Security Benchmark
 
-The `token-security-benchmark` is a comprehensive repository aimed at identifying and cataloging scams like honeypots, and intentional backdoors that may be present in token smart contracts within the crypto ecosystem. This benchmark serves as:
+Token Security Benchmark(TSB) aims at identifying and cataloging scams like honeypots, and intentional backdoors that may be present in token smart contracts within the crypto ecosystem. This benchmark serves as:
 
 - **A Shield against Malicious Contracts:** By showcasing a defined list of malicious token contract patterns, it empowers users and project teams to recognize and steer clear of contracts with hidden intents, thereby ensuring safer interactions within the decentralized space.
 
@@ -15,14 +15,10 @@ The `token-security-benchmark` is a comprehensive repository aimed at identifyin
 - **Descriptions:** Each pattern is thoroughly dissected, detailing its operation, potential consequences, and techniques for avoidance.
 - **Real-world Samples:** For each pattern, contract samples that exemplify the described malicious intent are provided, forming a practical point of reference.
 
-## How to Contribute
+## Contribute
 
 Maintaining the relevance and comprehensiveness of this repository is a joint endeavor. We earnestly welcome community contributions. For details on how to contribute, kindly refer to our [Contribution Guidelines](./CONTRIBUTING.md).
 
 ## Acknowledgments
 
 Our profound gratitude to all developers, researchers, and crypto enthusiasts who have been instrumental in shaping this repository. We hope to collaboratively fortify crypto user security and invite everyone to join this collective endeavor.
-
-## License
-
-This repository is distributed under the Apache License, Version 2.0. For more specifics, please review our [LICENSE](./LICENSE) file.

docs/index.md

@@ -1,9 +1,9 @@
-# Token Security Benchmark (TSB)
+# Token Security Benchmark
 
-The `token-security-benchmark` is a comprehensive repository aimed at identifying and cataloging scams like honeypots, and intentional backdoors that may be present in token smart contracts within the crypto ecosystem. This benchmark serves as:
+Token Security Benchmark(TSB) aims at identifying and cataloging scams like honeypots, and intentional backdoors that may be present in token smart contracts within the crypto ecosystem. This benchmark serves as:
 
 - **A Shield against Malicious Contracts:** By showcasing a defined list of malicious token contract patterns, it empowers users and project teams to recognize and steer clear of contracts with hidden intents, thereby ensuring safer interactions within the decentralized space.
- 
+
 - **A Testing Ground for Developers:** With a clear classification of malicious patterns and real-world examples, developers creating tools to detect these malicious token smart contracts can effectively evaluate their systems against a standardized benchmark.
 
 - **A Catalyst for Research:** By elucidating the deceitful practices adopted in token smart contracts, we aspire to drive more research towards crypto user safety, encouraging the community to devise strategies that deter such behaviors.
@@ -15,14 +15,10 @@ The `token-security-benchmark` is a comprehensive repository aimed at identifyin
 - **Descriptions:** Each pattern is thoroughly dissected, detailing its operation, potential consequences, and techniques for avoidance.
 - **Real-world Samples:** For each pattern, contract samples that exemplify the described malicious intent are provided, forming a practical point of reference.
 
-## How to Contribute
+## Contribute
 
-Maintaining the relevance and comprehensiveness of this repository is a joint endeavor. We earnestly welcome community contributions. For details on how to contribute, kindly refer to our [Contribution Guidelines](./CONTRIBUTING.md).
+Maintaining the relevance and comprehensiveness of this repository is a joint endeavor. We earnestly welcome community contributions. For details on how to contribute, kindly refer to our [Contribution Guidelines](contributing.md).
 
 ## Acknowledgments
 
 Our profound gratitude to all developers, researchers, and crypto enthusiasts who have been instrumental in shaping this repository. We hope to collaboratively fortify crypto user security and invite everyone to join this collective endeavor.
-
-## License
-
-This repository is distributed under the Apache License, Version 2.0. For more specifics, please review our [LICENSE](./LICENSE) file.