diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index 619dd86..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,23 +0,0 @@ -name: Publish new release - -on: - push: - branches: - - main - -jobs: - - publish: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - run: zip -r compris.zip compris -x "*.DS_Store" - - name: Upload style to release - uses: svenstaro/upload-release-action@v2 - if: startsWith(github.ref, 'refs/tags/') - with: - repo_token: ${{ secrets.GITHUB_RELEASE_TOKEN }} - file: compris.zip diff --git a/README.md b/README.md index 826e226..b373f8a 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,27 @@ A [Vale](https://vale.sh)-compatible prose style for non-native English speakers. Tailored for technical documentation. +## Status: alpha + +**compris** is still in its early stages. It is usable but expect massive changes before it becomes stable. + +## Usage + +Add to the list of `Packages` in the `.vale.ini` file. + +```ini +StylesPath = .github/styles +MinAlertLevel = suggestion + +Packages = proselint, \ +https://github.com/Microflash/compris/releases/download/latest/compris.zip + +[README.md] +BasedOnStyles = Vale, compris, proselint +``` + +To sync the latest updates, run `vale sync`. + ## Guiding principles - Use short sentences (< 30 words).