Skip to content

Commit 5de4856

Browse files
committed
docs: fix License section + use canonical codecov badge URL
Two README issues: 1. **License section said MIT instead of Apache-2.0.** The LICENSE file in the repo root is Apache-2.0, but the README's License section at the bottom still read 'MIT' (placeholder from the scaffold). Replace with a proper License section that: - Names the copyright holder (2026 Gilbert Wong) - Points to the LICENSE file - Includes the standard Apache 2.0 disclaimer boilerplate - Links to https://www.apache.org/licenses/LICENSE-2.0 2. **Codecov badge used the shields.io variant.** Switched to the canonical codecov.io badge URL: https://codecov.io/gh/<org>/<repo>/graph/badge.svg The shields.io variant still works, but the codecov.io-native badge is what users expect on Elixir projects and what the GitHub repo sidebar links to (https://codecov.io/gh/gilbertwong96/ado_cli). Also fixed the 'git clone' command at the top of the install section — was using the 'your-org/ado_cli' placeholder from the scaffold, now points to the real repo URL.
1 parent d06c180 commit 5de4856

1 file changed

Lines changed: 13 additions & 3 deletions

File tree

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Built with [Finch](https://hex.pm/packages/finch),
99
[Burrito](https://hex.pm/packages/burrito).
1010

1111
[![CI](https://github.com/gilbertwong96/ado_cli/actions/workflows/ci.yml/badge.svg)](https://github.com/gilbertwong96/ado_cli/actions/workflows/ci.yml)
12-
[![codecov](https://img.shields.io/codecov/c/github/gilbertwong96/ado_cli?logo=codecov)](https://codecov.io/gh/gilbertwong96/ado_cli)
12+
[![codecov](https://codecov.io/gh/gilbertwong96/ado_cli/graph/badge.svg)](https://codecov.io/gh/gilbertwong96/ado_cli)
1313
[![Elixir](https://img.shields.io/badge/elixir-1.20+-purple.svg)](https://elixir-lang.org)
1414
[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
1515

@@ -18,7 +18,7 @@ Built with [Finch](https://hex.pm/packages/finch),
1818
## Installation
1919

2020
```bash
21-
git clone https://github.com/your-org/ado_cli.git
21+
git clone https://github.com/gilbertwong96/ado_cli.git
2222
cd ado_cli
2323
mix deps.get
2424
mix escript.build
@@ -551,4 +551,14 @@ self-hosted deployments.
551551

552552
## License
553553

554-
MIT
554+
Copyright © 2026 Gilbert Wong
555+
556+
This project is licensed under the **Apache License, Version 2.0** — see the
557+
[LICENSE](LICENSE) file for the full text. You may obtain a copy of the
558+
license at <https://www.apache.org/licenses/LICENSE-2.0>.
559+
560+
Unless required by applicable law or agreed to in writing, software
561+
distributed under the License is distributed on an "AS IS" BASIS,
562+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
563+
See the License for the specific language governing permissions and
564+
limitations under the License.

0 commit comments

Comments
 (0)