From d0139f7c9a1741c5fcf6d17bdbc22c6fa23eea98 Mon Sep 17 00:00:00 2001 From: Rene Haas Date: Thu, 13 Oct 2022 14:26:13 +0200 Subject: [PATCH] improve readme --- README.md | 8 ++++++++ packages/overlayscrollbars/README.md | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ff7916a..316bcfd 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,7 @@ I've created this plugin because I hate ugly and space consuming scrollbars. Sim - Bidirectional - LTR or RTL direction support - Simple and effective scrollbar styling - TypeScript support - fully written in TypeScript + - Incredibly well tested - extensive unit, integration & e2e tests ## Getting started @@ -431,8 +432,15 @@ OverlayScrollbars.plugin([SizeObserverPlugin, ClickScrollPlugin]); #### Writing Plugins +> __Note__: For now please refer to the TypeScript definitions for a more detailed description. + You can write and publish your own Plugins. This section is a work in progress. +## Feature comparison to `v1` + +- The `scroll` function is missing. Planned as a `plugin`. (WIP) +- Initialization to the `textarea` element isn't supported yet. Planned as a `plugin`. (WIP) + ## Sponsors diff --git a/packages/overlayscrollbars/README.md b/packages/overlayscrollbars/README.md index 281538d..316bcfd 100644 --- a/packages/overlayscrollbars/README.md +++ b/packages/overlayscrollbars/README.md @@ -41,7 +41,7 @@ I've created this plugin because I hate ugly and space consuming scrollbars. Sim - Bidirectional - LTR or RTL direction support - Simple and effective scrollbar styling - TypeScript support - fully written in TypeScript - - Very well tested - extensive unit & e2e tests + - Incredibly well tested - extensive unit, integration & e2e tests ## Getting started