Skip to content

Commit 47d53ea

Browse files
committed
docs: update readme and remove changelog.md in favor of gh releases
1 parent e3080aa commit 47d53ea

2 files changed

Lines changed: 12 additions & 32 deletions

File tree

CHANGELOG.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

README.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
<div align="center"><img src="https://res.cloudinary.com/adonis-js/image/upload/v1620150474/edge-banner_tzmnox.jpg" width="600px"></div>
1+
# edge-error
2+
> Create errors with custom stack trace pointing to a ".edge" file
23
3-
# Edge error
4-
> Create errors custom stack trace pointing to the Edge source file
4+
[![github-actions-image]][github-actions-url] [![npm-image]][npm-url] [![license-image]][license-url] [![typescript-image]][typescript-url]
55

6-
[![gh-workflow-image]][gh-workflow-url] [![typescript-image]][typescript-url] [![npm-image]][npm-url] [![license-image]][license-url] [![synk-image]][synk-url]
7-
8-
The package extends the native Error class and adds support for pushing an error stack frame pointing to an Edge template.
6+
The package extends the native Error class and adds support for pushing an error stack frame pointing to a ".edge" template file.
97

108
## Usage
11-
Install the package from npm registry as follows
9+
Install the package from the npm packages registry.
1210

1311
```bash
1412
npm i edge-error
@@ -20,7 +18,7 @@ yarn add edge-error
2018
Then use it as follows
2119

2220
```js
23-
const { EdgeError } = require('edge-error')
21+
import { EdgeError } from 'edge-error'
2422

2523
throw new EdgeError('message', 'status', {
2624
line: 1,
@@ -29,17 +27,14 @@ throw new EdgeError('message', 'status', {
2927
})
3028
```
3129

32-
[gh-workflow-image]: https://img.shields.io/github/workflow/status/edge-js/error/test?style=for-the-badge
33-
[gh-workflow-url]: https://github.com/edge-js/error/actions/workflows/test.yml "Github action"
34-
35-
[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
36-
[typescript-url]: "typescript"
30+
[github-actions-image]: https://img.shields.io/github/workflow/status/edge-js/error/test?style=for-the-badge
31+
[github-actions-url]: https://github.com/edge-js/error/actions/workflows/test.yml "github-actions"
3732

3833
[npm-image]: https://img.shields.io/npm/v/edge-error.svg?style=for-the-badge&logo=npm
39-
[npm-url]: https://npmjs.org/package/edge-error 'npm'
34+
[npm-url]: https://npmjs.org/package/edge-error "npm"
4035

4136
[license-image]: https://img.shields.io/npm/l/edge-error?color=blueviolet&style=for-the-badge
42-
[license-url]: LICENSE.md 'license'
37+
[license-url]: LICENSE.md "license"
4338

44-
[synk-image]: https://img.shields.io/snyk/vulnerabilities/github/edge-js/error?label=Synk%20Vulnerabilities&style=for-the-badge
45-
[synk-url]: https://snyk.io/test/github/edge-js/error?targetFile=package.json "synk"
39+
[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
40+
[typescript-url]: "typescript"

0 commit comments

Comments
 (0)