馃敄 Release 0.10.0-beta.0

parent 4ba57adf
Pipeline #3363 passed with stage
in 1 minute and 47 seconds
# Pre-release
## Version 0.10
### Version 0.10.0-beta.0
- Add `weak-value-map` support
- `weak-value-map` is a library that allows user and channel caches in bancho.js to be cleaned once they are no longer referenced.
- It is an optional peer dependency, with fallback to regular `Map` when unpresent. It is highly recommended however, especially on large instances, as without that, cache is never cleared in any way.
- Upgrade dependencies
## Version 0.9
### Version 0.9.7
......
......@@ -3,7 +3,7 @@
[![NPM](https://nodei.co/npm/bancho.js.png?compact=true)](https://nodei.co/npm/bancho.js/)
[![pipeline status](https://git.cartooncraft.fr/ThePooN/bancho.js/badges/master/pipeline.svg)](https://git.cartooncraft.fr/ThePooN/bancho.js/commits/master)
## Current release: v0.9.7
## Current release: v0.10.0-beta.0
# Introduction
......@@ -28,6 +28,9 @@ osu! accounts by default have undisclosed rate limits. Therefore, this library u
# Getting Started
First, install the library: `npm i bancho.js`.
The optional `weak-value-map` dependency is also highly recommended, as the various caches in place do never get cleaned otherwise. It is marked as optional since it is a native dependency (they can be tough to set up in some environments). For development purposes, it is not necessary to bother with that.
Let's get straight into it with a working example. This will print all your incoming PMs to the console:
```javascript
const Banchojs = require("bancho.js");
......@@ -50,6 +53,10 @@ This library is very near completion. Thanks to everyone who supported and are n
There must still be some improvements to be done though. Feel free to hop on my [Discord server](https://discord.gg/ThePooN) so we can figure out issues and improve the code!
You can financially support this project by [subscribing](https://twitch.tv/ThePooN02/subscribe) to my Twitch channel or [donating](https://streamlabs.com/ThePooN02).
# Compatibility
bancho.js supports all currently supported Node.js releases. See [Node's LTS schedule](https://nodejs.org/en/about/releases/).
# License
It is licensed as GPL 3.0. The entire license text is available in the [LICENSE](/LICENSE) file, however I recommend you to take a look at this [short summary](https://choosealicense.com/licenses/gpl-3.0/) to get a better idea!
......
{
"name": "bancho.js",
"version": "0.9.7",
"version": "0.10.0-beta.0",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
......
{
"name": "bancho.js",
"version": "0.9.7",
"version": "0.10.0-beta.0",
"description": "Interface with Bancho over IRC, made easy and reliable",
"main": "index.js",
"types": "index.d.ts",
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment