Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
clementroche committed Apr 28, 2024
1 parent 90a3aba commit 46c6991
Show file tree
Hide file tree
Showing 9 changed files with 216 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,13 @@

## Introduction

This is our take on smooth scroll, lightweight, hard-working, smooth as butter scroll. See [Demo](https://lenis.darkroom.engineering/).
Lenis is a lightweight, robust, and performant smooth scroll library. It's designed by [@darkroom.engineering](https://twitter.com/darkroomdevs) to be simple to use and easy to integrate into your projects. It's built with performance in mind and is optimized for modern browsers. It's perfect for creating smooth scrolling experiences on your website such as webgl scroll synching, parallax effects and much more. See [ Demo](https://lenis.darkroom.engineering/) and [Showcase](#lenis-in-use).

<br/>

## Sponsorship

If you like Lenis, please consider [sponsoring us](https://github.com/sponsors/darkroomengineering). Your support helps us maintain the project and continue to improve it.

<br>

Expand Down
8 changes: 8 additions & 0 deletions packages/snap/dist/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
export default class Snap {
constructor(lenis: any);
destroy(): void;
add(element: any, options?: {}): void;
remove(element: any): void;
onWindowResize: () => void;
onScroll: (e: any) => void;
}
10 changes: 10 additions & 0 deletions packages/snap/dist/lenis-snap.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
declare class Snap {
constructor(lenis: any);
destroy(): void;
add(element: any, options?: {}): void;
remove(element: any): void;
onWindowResize: () => void;
onScroll: (e: any) => void;
}

export { Snap as default };
184 changes: 184 additions & 0 deletions packages/snap/dist/lenis-snap.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions packages/snap/dist/lenis-snap.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

1 comment on commit 46c6991

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"⚡️ Lighthouse report for the changes in this commit:

🟢 Performance: 91
🟢 Accessibility: 96
🟢 Best practices: 100
🟠 SEO: 67
🟠 PWA: 56

Lighthouse ran on https://lenis-emslefewp-studio-freight.vercel.app/"

Please sign in to comment.