Skip to content

Commit

Permalink
chore: Remove beta references from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
megahertz committed Oct 24, 2023
1 parent 8ae8988 commit 19bb2a1
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 10 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
[![NPM version](https://badge.fury.io/js/electron-log.svg)](https://badge.fury.io/js/electron-log)
[![Downloads](https://img.shields.io/npm/dw/electron-log)](https://img.shields.io/npm/dw/electron-log)

New v5 beta is ready and I would be grateful
[for any feedbacks](https://github.com/megahertz/electron-log/discussions/333).

Simple logging module Electron/Node.js/NW.js application.
No dependencies. No complicated configuration.

Expand All @@ -17,13 +14,13 @@ By default, it writes logs to the following locations:

## Installation

Currently, electron-log v5 is in a beta phase. It requires Electron 13+ or
Starts from v5, electron-log requires Electron 13+ or
Node.js 14+. Feel free to use electron-log v4 for older runtime. v4
supports Node.js 0.10+ and almost any Electron build.

Install with [npm](https://npmjs.org/package/electron-log):

npm install electron-log@beta
npm install electron-log

## Usage

Expand Down Expand Up @@ -216,7 +213,7 @@ is a function which is called on each transport call.
You can create multiple logger instances with different settings:

```js
import log from 'electron-log';
import log from 'electron-log/main';

const anotherLogger = log.create('anotherInstance');
```
Expand All @@ -227,7 +224,7 @@ separately.
### Logging scopes

```js
import log from 'electron-log';
import log from 'electron-log/main';
const userLog = log.scope('user');

userLog.info('message with user scope');
Expand Down
6 changes: 3 additions & 3 deletions docs/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ it should be initialized in the main process before the first window is created:

**main.js**
```js
import log from 'electron-log';
import log from 'electron-log/main';

// It preloads electron-log IPC code in renderer processes
log.initialize();
Expand All @@ -37,7 +37,7 @@ After that, you can use the library as before.

**renderer.ts**
```typescript
import log from 'electron-log';
import log from 'electron-log/renderer';
log.info('Log from the renderer');
````
Expand All @@ -56,7 +56,7 @@ To make callback names more obvious, some options where renamed:
- remote.onError -> remote.processErrorFn({ error, message, request })
- remote.transformBody -> remote.makeBodyFn({ logger, message, transport })
## Error catching
### Error catching
- log.catchErrors -> log.errorHandler.startCatching
Expand Down

0 comments on commit 19bb2a1

Please sign in to comment.