Skip to content

Commit

Permalink
docs: clean up README
Browse files Browse the repository at this point in the history
  • Loading branch information
bconnorwhite committed Jan 5, 2023
1 parent 28df860 commit 58d51e6
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<div align="center">
<!--BEGIN HEADER-->
<div id="top" align="center">
<h1>@autosoft/tsconfig</h1>
<a href="https://npmjs.com/package/autosoft/tsconfig">
<a href="https://npmjs.com/package/@autosoft/tsconfig">
<img alt="npm" src="https://img.shields.io/npm/v/@autosoft/tsconfig.svg">
</a>
<a href="https://github.com/autosoftoss/tsconfig">
Expand All @@ -12,6 +13,8 @@

<blockquote align="center">A base for TypeScript projects.</blockquote>

<br />

_If I should maintain this repo, please ⭐️_
<a href="https://github.com/autosoftoss/tsconfig">
<img align="right" alt="GitHub stars" src="https://img.shields.io/github/stars/autosoftoss/tsconfig?label=%E2%AD%90%EF%B8%8F&style=social">
Expand All @@ -23,6 +26,7 @@ _DM me on [Twitter](https://twitter.com/bconnorwhite) if you have questions or s
</a>

---
<!--END HEADER-->

This package includes `typescript`, `ts-node`, and a base `tsconfig.json`, providing a quick way to start TypeScript projects.

Expand Down Expand Up @@ -95,21 +99,28 @@ The config enable strict type checking, and includes SWC for ts-node:
}
```

<!--BEGIN FOOTER-->

<br />

<h2 id="dependencies">Dependencies<a href="https://www.npmjs.com/package/autosoft/tsconfig?activeTab=dependencies"><img align="right" alt="dependencies" src="https://img.shields.io/librariesio/release/npm/@autosoft/tsconfig.svg"></a></h2>
<h2 id="dependencies">Dependencies<a href="https://www.npmjs.com/package/@autosoft/tsconfig?activeTab=dependencies"><img align="right" alt="dependencies" src="https://img.shields.io/librariesio/release/npm/@autosoft/tsconfig.svg"></a></h2>

- [@swc/core](https://www.npmjs.com/package/@swc/core): Super-fast alternative for babel
- [@types/node](https://www.npmjs.com/package/@types/node): TypeScript definitions for Node.js
- [ts-node](https://www.npmjs.com/package/ts-node): TypeScript execution environment and REPL for node.js, with source map support
- [typescript](https://www.npmjs.com/package/typescript): TypeScript is a language for application scale JavaScript development

<h3 id="dev-dependencies">Dev Dependencies</h3>

<br />

<h3>Dev Dependencies</h3>

- [jsonlint](https://www.npmjs.com/package/jsonlint): Validate JSON


<br />

<h2 id="license">License <a href="https://opensource.org/licenses/MIT"><img align="right" alt="license" src="https://img.shields.io/npm/l/@autosoft/tsconfig.svg"></a></h2>

[MIT](https://opensource.org/licenses/MIT)
<!--END FOOTER-->

0 comments on commit 58d51e6

Please sign in to comment.