Merge pull request #13 from AtelierArith/update-readme-and-add-compathelper

Update README and add CompatHelper workflow

Author: terasakisatoshi

.github/workflows/CompatHelper.yml

@@ -0,0 +1,19 @@
+name: CompatHelper
+on:
+  schedule:
+    - cron: 0 0 * * *
+  workflow_dispatch:
+jobs:
+  CompatHelper:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      contents: write
+    steps:
+      - name: Pkg.add("CompatHelper")
+        run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
+      - name: CompatHelper.main()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
+        run: julia -e 'using CompatHelper; CompatHelper.main()'

README.md

@@ -20,8 +20,7 @@ RustToolChain.jl is a Julia package that provides Rust toolchains (especially `c
 ## Installation
 
 ```julia
-using Pkg
-Pkg.add(url="https://github.com/AtelierArith/RustToolChain.jl.git")
+using Pkg; Pkg.add("RustToolChain")
 ```
 
 ## Usage