Skip to content

Latest commit

 

History

History

lib

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
README.md
README.md
 
 
build.config.ts
build.config.ts
 
 
eslint.config.js
eslint.config.js
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

Enclosed lib

This package contains the core functionalities of Enclosed, an open-source project that aims to provide a simple and secure way to share e2e encrypted notes.

Installation

# with npm
npm install @enclosed/lib

# with yarn
yarn add @enclosed/lib

# with pnpm
pnpm add @enclosed/lib

Usage

import { createNote } from '@enclosed/lib';

const { noteUrl } = await createNote({
  content: 'Hello, World!',
  password: 'password',
  ttlInSeconds: 3600,
  deleteAfterReading: true,
});

console.log(noteUrl);

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for more information.

Credits and Acknowledgements

This project is crafted with ❤️ by Corentin Thomasset.