diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml new file mode 100644 index 0000000..4230c5a --- /dev/null +++ b/.github/workflows/lint.yaml @@ -0,0 +1,33 @@ +name: Linting + +on: pull_request + +jobs: + lint: + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v4 + + - name: Setup bun + uses: oven-sh/setup-bun@v1 + + - name: Install dependencies + run: bun install + + - name: Format files + run: bun run format + + - name: Check for changes + run: | + if [ -n "$(git status --porcelain)" ]; then + echo Following files are changed by the formatter... + git status + + echo Changes: + git diff + + exit 1; + else + exit 0; + fi diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index dcd1607..4c5f5e7 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -3,19 +3,18 @@ on: - pull_request jobs: - setup-and-test: - name: setup-and-test + test: + name: Test runs-on: ubuntu-latest steps: - - name: checkout - uses: actions/checkout@v3 + - name: Checkout repo + uses: actions/checkout@v4 - - name: setup bun + - name: Setup bun uses: oven-sh/setup-bun@v1 - # run any `bun` or `bunx` command - - name: install dependencies + - name: Install dependencies run: bun install - - name: run tests + - name: Run tests run: bun run test diff --git a/.gitignore b/.gitignore index f3f691e..b295889 100644 --- a/.gitignore +++ b/.gitignore @@ -129,4 +129,4 @@ dist .yarn/install-state.gz .pnp.* -.DS_Store \ No newline at end of file +.DS_Store diff --git a/README.md b/README.md index d7d8021..25a676f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -# public-chain-configs +# Axelar configs -A public registry for chains and asset configurations +A public registry for chains and asset configurations for applications built on the Axelar network. ## Getting started Before we begin, make sure your system has the minimum runtime requirements: - [git](https://git-scm.com/downloads) -- [bun](https://bun.sh/) >= 1.0 +- [bun](https://bun.sh/) >= 1.0 OR [npm](https://docs.npmjs.com/) To install `bun`, run the following command: @@ -15,16 +15,16 @@ To install `bun`, run the following command: curl -fsSL https://bun.sh/install | bash ``` -Once you have `nodejs` and `bun`, you can clone this repository: +Once you have `bun` or `nodejs` installed, you can clone this repository: ```bash -git clone git@github.com:axelarnetwork/public-chain-configs.git +git clone git@github.com:axelarnetwork/axelar-configs.git ``` cd into the folder ```bash -cd public-chain-configs +cd axelar-configs ``` Install dependencies diff --git a/images/.DS_Store b/images/.DS_Store deleted file mode 100644 index a1aeb95..0000000 Binary files a/images/.DS_Store and /dev/null differ diff --git a/images/tokens/.DS_Store b/images/tokens/.DS_Store deleted file mode 100644 index 5008ddf..0000000 Binary files a/images/tokens/.DS_Store and /dev/null differ diff --git a/package.json b/package.json index 277a261..269f38e 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { - "name": "public-chain-configs", - "version": "0.0.1", - "description": "Axelar Network public chain & assets registry", + "name": "axelar-configs", + "version": "1.0.0", + "description": "A public registry for chains and asset configurations for applications built on the Axelar network", "type": "module", "scripts": { "format": "prettier --write .", @@ -12,7 +12,12 @@ "test": "vitest --run", "prepare": "husky install" }, - "keywords": [], + "keywords": [ + "axelar", + "ethereum", + "blockchain", + "interoperability" + ], "license": "LicenseRef-LICENSE", "dependencies": { "@inquirer/prompts": "^3.2.0"