Skip to content

Commit 7526e35

Browse files
committed
release 1.0.3 - updates to README
1 parent e466d67 commit 7526e35

File tree

2 files changed

+89
-2
lines changed

2 files changed

+89
-2
lines changed

README.md

+88-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,88 @@
1-
# angular-logger
1+
2+
# Angular Logger by Avernix Technologies
3+
4+
Angular Logger is a simple logging tool
5+
6+
7+
8+
9+
## Installation
10+
11+
Install @trarn/angular-logger with npm
12+
13+
```bash
14+
npm i @trarn/angular-logger
15+
```
16+
17+
Install @trarn/angular-logger with yarn
18+
```bash
19+
yarn add @trarn/angular-logger
20+
```
21+
## Usage
22+
23+
24+
```javascript
25+
// CommonJS
26+
const { log } = require('@trarn/angular-logger');
27+
28+
// ESM
29+
import { log } from '@trarn/angular-logger';
30+
```
31+
32+
# Available Log Levels
33+
34+
| Parameter | Type | Description |
35+
| :-------- | :------- | :-------------------------------- |
36+
| `info` | `method` | Accepts two properties; message and data. Again, data can be an object, array, etc. |
37+
| `debug` | `method` | Accepts two properties; message and data. Again, data can be an object, array, etc. |
38+
| `error` | `method` | Accepts two properties; message and data. Again, data can be an object, array, etc. |
39+
| `warn` | `method` | Accepts two properties; message and data. Again, data can be an object, array, etc. |
40+
| `group` | `method` | Accepts two properties; message and data. Again, data can be an object, array, etc. |
41+
| `groupEnd` | `method` | Accepts two properties; message and data. Again, data can be an object, array, etc. |
42+
| `Observable` | `method` | Interacts as an angular Observable |
43+
44+
45+
-- -
46+
47+
48+
## Authors
49+
50+
- [@avernixtechnologies](https://www.github.com/avernixtechnologies)
51+
52+
## Support
53+
54+
For support, email support@avernix.com or join our Discord channel [Our Discord](https://discord.gg/zpdd6VTxwg).
55+
56+
57+
## Contributing
58+
59+
We will be setting up a way for people to contribute, in the mean time, fork and create a pull request. Thanks!
60+
61+
62+
## Feedback
63+
64+
If you have any feedback, please reach out to us at feedback@avernix.com
65+
66+
67+
## Avernix Technologies
68+
69+
Avernix Technologies is a software company dedicated to providing solutions for businesses big and small, or even hobbyists.
70+
71+
72+
73+
## License
74+
75+
[MIT](https://choosealicense.com/licenses/mit/)
76+
77+
78+
## Roadmap
79+
80+
- More to come
81+
82+
83+
## Used By
84+
85+
This project is used by the following companies:
86+
87+
- Avernix Technologies
88+

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@trarn/angular-logger",
3-
"version": "1.0.2",
3+
"version": "1.0.3",
44
"description": "A logger built with angular in mind",
55
"type": "module",
66
"types": "build/index.d.ts",

0 commit comments

Comments
 (0)