Skip to content

Commit

Permalink
fix: readme cleanups (#135)
Browse files Browse the repository at this point in the history
  • Loading branch information
brandonjpierce authored Dec 18, 2024
1 parent dd6bd3f commit 9aa537f
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 17 deletions.
5 changes: 4 additions & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@
* @brandonjpierce @ArrayKnight @belsrc

# Core pacakge
/packages/core @brandonjpierce @belsrc
/packages/core @belsrc @brandonjpierce

# Design system pacakge
/packages/design-system @ArrayKnight @switzerb

# Geo package
/packages/geo @kalisjoshua @brandonjpierce
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,6 @@ Developer Toolkit development is governed by the Technical Steering Committee (T
- [Brandon Pierce](https://github.com/brandonjpierce)
- [Brenna Switzer](https://github.com/switzerb)
- [Josh Kalis](https://github.com/kalisjoshua)
- [Teddy Ortega](https://github.com/orteth01)

Maintainers of the Developer Toolkit have write access to this GitHub repository, and take part in the decision making process.
40 changes: 24 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,30 @@

Libraries are exposed via individual packages. Refer to each package documentation for available utilities.

Documentation | Package
--------------|-------------
[Biome Config](#link-to-docs) | `@accelint/biome-config`
[Constants](#link-to-docs) | `@accelint/constants`
[Converters](#link-to-docs) | `@accelint/converters`
[Design System](#link-to-docs) | `@accelint/design-system`
[Eslint Config](#link-to-docs) | `@accelint/eslint-config`
[Formatters](#link-to-docs) | `@accelint/formatters`
[Geo](#link-to-docs) | `@accelint/geo`
[Math](#link-to-docs) | `@accelint/math`
[Prettier Config](#link-to-docs) | `@accelint/prettier-config`
[Typescript Config](#link-to-docs) | `@accelint/typescript-config`
[Predicates](#link-to-docs) | `@accelint/predicates`
[Vitest Config](#link-to-docs) | `@accelint/vitest-config`
[Web Worker](#link-to-docs) | `@accelint/web-worker`
[Websocket](#link-to-docs) | `@accelint/websocket`
| Documentation | Package |
| ---------------------------------------------------------|---------------------------- |
| [Constants](./packages/constants/documentation) | `@accelint/constants` |
| [Converters](./packages/converters/documentation) | `@accelint/converters` |
| [Design System](./packages/design-system/documentation) | `@accelint/design-system` |
| [Formatters](./packages/formatters/documentation) | `@accelint/formatters` |
| [Geo](./packages/geo/documentation) | `@accelint/geo` |
| [Math](./packages/math/documentation) | `@accelint/math` |
| [Predicates](./packages/predicates/documentation) | `@accelint/predicates` |
| [Predicates](./packages/temporal/documentation) | `@accelint/temporal` |
| [Web Worker](./packages/web-worker/documentation) | `@accelint/web-worker` |
| [Websocket](./packages/websocket/documentation) | `@accelint/websocket` |



We also export configurations for common tooling in our applications.

| Package |
| ----------------------------- |
| `@accelint/biome-config` |
| `@accelint/eslint-config` |
| `@accelint/prettier-config` |
| `@accelint/typescript-config` |
| `@accelint/vitest-config` |

## 💡 Contributing

Expand Down
Binary file removed assets/air-force.png
Binary file not shown.

0 comments on commit 9aa537f

Please sign in to comment.