Skip to content

Commit

Permalink
docs: add badge to all
Browse files Browse the repository at this point in the history
  • Loading branch information
njfamirm committed Dec 10, 2024
1 parent f96e7d2 commit 4c384af
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ This repository contains numerous small utility packages. These packages serve v
Here is a brief overview of the included libraries:

1. [`element`](./packages/element): Utility functions and mixins for building high-performance web components with Lit.
1. [`alpine`](./packages/alpine): Utility functions to enhance Alpine.js usage with backup support.
2. [`typescript-config`](./packages/typescript-config): Base TypeScript configuration for Nexim projects.
3. [`prettier-config`](./packages/prettier-config): Base Prettier configuration for Nexim projects.
4. [`eslint-config`](./packages/eslint-config): Base Eslint configuration for Nexim projects.
2. [`alpine`](./packages/alpine): Utility functions to enhance Alpine.js usage with backup support.
3. [`typescript-config`](./packages/typescript-config): Base TypeScript configuration for Nexim projects.
4. [`prettier-config`](./packages/prettier-config): Base Prettier configuration for Nexim projects.
5. [`eslint-config`](./packages/eslint-config): Base Eslint configuration for Nexim projects.

For more detailed information and guidelines on how to use each package, please refer to each package's README.

Expand Down
1 change: 0 additions & 1 deletion packages/alpine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
![Build & Lint & Test](https://github.com/the-nexim/nanolib/actions/workflows/build-lint-test.yaml/badge.svg)
![NPM Downloads](https://img.shields.io/npm/dm/%40nexim%2Falpine)
![NPM License](https://img.shields.io/npm/l/%40nexim%2Falpine)
![Code Coverage](https://img.shields.io/codecov/c/github/the-nexim/nanolib)

## Overview

Expand Down
6 changes: 6 additions & 0 deletions packages/eslint-config/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Nexim's ESLint Configurations

![NPM Version](https://img.shields.io/npm/v/%40nexim%2Feslint-config)
![npm bundle size](https://img.shields.io/bundlephobia/min/%40nexim%2Feslint-config)
![Build & Lint & Test](https://github.com/the-nexim/nanolib/actions/workflows/build-lint-test.yaml/badge.svg)
![NPM Downloads](https://img.shields.io/npm/dm/%40nexim%2Feslint-config)
![NPM License](https://img.shields.io/npm/l/%40nexim%2Feslint-config)

Alwatr ECMAScript Style Guide as a ESLint [shareable configurations](http://eslint.org/docs/developer-guide/shareable-configs.html).

## Installation
Expand Down
6 changes: 6 additions & 0 deletions packages/prettier-config/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Nexim's Prettier Configurations

![NPM Version](https://img.shields.io/npm/v/%40nexim%2Fprettier-config)
![npm bundle size](https://img.shields.io/bundlephobia/min/%40nexim%2Fprettier-config)
![Build & Lint & Test](https://github.com/the-nexim/nanolib/actions/workflows/build-lint-test.yaml/badge.svg)
![NPM Downloads](https://img.shields.io/npm/dm/%40nexim%2Fprettier-config)
![NPM License](https://img.shields.io/npm/l/%40nexim%2Fprettier-config)

Nexim's [shareable configurations](https://prettier.io/docs/en/configuration.html#sharing-configurations) for [Prettier](https://prettier.io/).

## Installation
Expand Down
6 changes: 6 additions & 0 deletions packages/typescript-config/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Nexim TypeScript Config

![NPM Version](https://img.shields.io/npm/v/%40nexim%2Ftypescript-config)
![npm bundle size](https://img.shields.io/bundlephobia/min/%40nexim%2Ftypescript-config)
![Build & Lint & Test](https://github.com/the-nexim/nanolib/actions/workflows/build-lint-test.yaml/badge.svg)
![NPM Downloads](https://img.shields.io/npm/dm/%40nexim%2Ftypescript-config)
![NPM License](https://img.shields.io/npm/l/%40nexim%2Ftypescript-config)

This is a base TypeScript configuration for Nexim projects.

## installation
Expand Down

0 comments on commit 4c384af

Please sign in to comment.