Skip to content

Commit 726d780

Browse files
authored
Enhance README with features and usage details
1 parent 5ef99c4 commit 726d780

File tree

1 file changed

+35
-9
lines changed

1 file changed

+35
-9
lines changed

README.md

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
11
# Hawk JavaScript Catcher
22

3-
[Hawk](https://github.com/codex-team/hawk) allows to track JavaScript and TypeScript errors in your applications.
4-
5-
Here is the [Hawk Web](//garage.hawk.so) client and here is the [Documentation](//docs.hawk.so).
6-
3+
Error tracking for JavaScript/TypeScript applications.
4+
5+
- [Hawk Web](//garage.hawk.so)
6+
- [Documentation (En)](//docs.hawk.so)
7+
- [Documentation (Ru)](//docs.hawk-tracker.ru)
8+
9+
## Features
10+
11+
- 🦅 Automatic error catching
12+
- 💎 Manual error and logs sending
13+
- 🙂 Attaching user information
14+
- 📦 Attaching additional context
15+
- 🛡️ Sensitive data filtering
16+
- 🌟 Source maps consuming
17+
- 💬 Console logs tracking
18+
- <img src="https://cdn.svglogos.dev/logos/vue.svg" width="16" height="16"> &nbsp;Vue support
19+
- <img src="https://cdn.svglogos.dev/logos/react.svg" width="16" height="16"> &nbsp;React support
20+
721
## Installation
822

923
We recommend adding Hawk script to page above others to prevent missing any errors.
@@ -78,10 +92,6 @@ Initialization settings:
7892

7993
Other available [initial settings](types/hawk-initial-settings.d.ts) are described at the type definition.
8094

81-
### Usage in React project
82-
83-
You can use the JavaScript catcher in your React project. Create the Hawk Catcher instance in a `index.js` file of your project.
84-
8595
## Manual sending
8696

8797
You can send errors or other messages to the Hawk manually, for example at your `catch` blocks or any debug conditions.
@@ -135,7 +145,7 @@ window.hawk = new HawkCatcher({
135145
136146
You can use the `beforeSend()` hook to prevent sending a particular event. Return `false` for that.
137147
138-
## Integrate to Vue application
148+
## Usage with &nbsp; <img src="https://cdn.svglogos.dev/logos/vue.svg" width="22"> &nbsp;Vue.js
139149
140150
Vue apps have their own error handler, so if you want to catcher errors thrown inside Vue components, you should set up a Vue integration.
141151
@@ -162,3 +172,19 @@ const hawk = new HawkCatcher({
162172

163173
hawk.connectVue(Vue)
164174
```
175+
176+
177+
## Usage with &nbsp; <img src="https://cdn.svglogos.dev/logos/react.svg" width="22"> &nbsp;React
178+
179+
React is suppported out of the box. No additional setup required.
180+
181+
Create the Hawk Catcher instance in a `index.js` file of your project.
182+
183+
184+
```js
185+
import HawkCatcher from '@hawk.so/javascript';
186+
187+
const hawk = new HawkCatcher({
188+
token: 'INTEGRATION_TOKEN'
189+
});
190+
```

0 commit comments

Comments
 (0)