diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 5463cb9..d785add 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,4 +1,4 @@ -name: Test Deno Module +name: Apex tests on: push: @@ -11,8 +11,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: extractions/setup-just@v1 - uses: actions/checkout@v2 - uses: denolib/setup-deno@v2 - name: Run tests - run: just test + run: ./apex test diff --git a/README.md b/README.md index 6be206d..caaeb5e 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,43 @@ -# Apex CLI +# Apexlang CLI -Apex is an interface definition language (IDL) for modeling software. Generate -source code, documentation, integration, everything automatically. +The `apex` CLI is a one-stop shop for all projects across all languages. -### Goals: +It's a -- Approachable - Apex was designed from the ground up to be succinct. - Interfaces and data types are described using familiar syntax that won't slow - you down. -- Protocol agnostic - Regardless of the architecture, your data and - interfaces are fundamentally the same. Use Apex to generate code for any - serialization format or protocol. -- Extensible - Generators are written in TypeScript. Easily add - custom generators that satisfy your unique needs and publish them for everyone - to use. +- Project templating and scaffolding tool +- Extensible code generation tool +- Task runner For more information, visit [https://apexlang.io](https://apexlang.io). -## Installation +## Prerequisites + +The `apex` CLI depends on Deno. -First, install [Deno](https://github.com/denoland/deno_install). +Install `deno` with instructions +[here](https://github.com/denoland/deno_install). -Then run the command below from a terminal. +## Installation + +To install a release version of the `apex` CLI, run the command below: ``` deno install -A --unstable -f -n apex https://deno.land/x/apex_cli/apex.ts ``` +To install from source, clone this repository and run `./apex run install` + +```sh +git clone https://github.com/apexlang/apex.git +cd apex +./apex install # or deno install -A --unstable ./apex.ts +``` + +## Usage + +Visit [https://apexlang.io](https://apexlang.io) for official documentation and +usage. + ```shell apex --help ``` @@ -39,7 +50,7 @@ Output: Description: - A code generation tool using Apex, an interface definition language (IDL) for modeling software. + A code generation tool using Apexlang, an interface definition language (IDL) for modeling software. Options: @@ -51,16 +62,33 @@ Output: install - Install templates locally. new