Skip to content

Commit 50a6366

Browse files
committed
docs: udpate readme
1 parent d91d315 commit 50a6366

1 file changed

Lines changed: 3 additions & 15 deletions

File tree

README.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# FlaggyJS 🚩 - Manage bitewise flags *wisely*
22

3+
> Made with ❤️‍🔥 by [David Jiménez](https://dubis.dev)
4+
35
`FlaggyJS` is a lightweight TypeScript library for managing bitwise flags.
4-
This library provides an efficient way to handle permission systems, feature toggles,
5-
or any context where managing a set of binary flags is needed.
6+
Powerful and efficient binary flags managing for permission systems, feature toggles, or any use-case.
67

78
```typescript
89
// 1. Import the library
@@ -82,16 +83,3 @@ The package uses `tsc` for building TypeScript into JavaScript:
8283
```bash
8384
bun run build
8485
```
85-
86-
### File Structure
87-
88-
- **`index.ts`**: Main source file containing the `useFlags` implementation.
89-
- **`flag-operations.js`**: Contains bitwise operations like `addFlag`, `addFlags`, `hasFlag`, and `removeFlag`.
90-
- **`input-validators.js`**: Handles validation of input flags.
91-
- **`index.test.ts`**: Unit tests for the package.
92-
93-
## Contributing
94-
95-
Contributions are welcome! If you encounter bugs, feel free to open an issue or submit a pull request.
96-
97-
> Made with ❤️‍🔥 by [David Jiménez](https://dubis.dev)

0 commit comments

Comments
 (0)