Skip to content

Commit

Permalink
add: re-styled README
Browse files Browse the repository at this point in the history
  • Loading branch information
utakotoba committed Dec 14, 2023
1 parent b591c0a commit 6ef4d66
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 8 deletions.
Binary file added .github/assets/ClercCard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"typescript.tsdk": "node_modules/typescript/lib",
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
"source.fixAll.eslint": "explicit"
},
"editor.tabCompletion": "on",
"diffEditor.codeLens": true,
Expand Down
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,35 @@
# Clerc: The full-featured cli library.
![Clerc Card](.github/assets/ClercCard.png)

![clerc](https://socialify.git.ci/clercjs/clerc/image?description=1&font=Source%20Code%20Pro&forks=1&issues=1&logo=https%3A%2F%2Fclerc.js.org%2Flogo.png&owner=1&pattern=Floating%20Cogs&pulls=1&stargazers=1&theme=Dark)
<p align="center">
<a target="_blank" href="https://clerc.js.org" noreferrer noopener>Clerc</a> is a full-featured library (tool set) for building CLI Apps in Node.js, Deno or Bun.
</p>

<div align="center">

[![Version](https://img.shields.io/npm/v/clerc.svg)](https://npmjs.org/package/clerc)
[![CI](https://github.com/clercjs/clerc/actions/workflows/ci.yml/badge.svg)](https://github.com/clercjs/clerc/actions/workflows/ci.yml)
[![Downloads/week](https://img.shields.io/npm/dw/clerc.svg)](https://npmjs.org/package/clerc)
[![License](https://img.shields.io/npm/l/clerc.svg)](https://github.com/clercjs/clerc/blob/main/package.json)

</div>

<hr/>

<!-- toc -->

- [πŸ—’ Description](#-description)
- [✨ Features](#-features)
- [😊 The simplest CLI example](#-the-simplest-cli-example)
- [πŸ“– Documentation](#-documentation)
- [πŸ¦„ Examples](#-examples)
- [πŸ€” More...](#-more)
- [Why using Clerc?](#why-using-clerc)
- [Why naming "Clerc"?](#why-naming-clerc)
- [πŸ“ License](#-license)
<!-- tocstop -->

> [!NOTE]
> This package is ESM-only.
# πŸ—’ Description

Clerc is a full/featured library (tool set) for building CLI Apps in Node.js, Deno or Bun.

# ✨ Features

- **Lightweight** - Dependencies are bundled and minified
Expand Down

0 comments on commit 6ef4d66

Please sign in to comment.