alpha release
update v0.8.0
This commit is contained in:
30
README.md
Normal file
30
README.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Twtkpr
|
||||
|
||||
An [ExpressJS](https://expressjs.com/) router for serving, sharing, and updating a
|
||||
[`twtxt.txt` file](https://twtxt.dev/).
|
||||
|
||||
> [!WARNING]
|
||||
> **STILL IN ALPHA**: Although this plugin lacks documentation, examples, tests, installation
|
||||
> flexibility, and polish, it's still fully-functional and actively deployed to at least one site.
|
||||
|
||||
### Features
|
||||
|
||||
- Uses JWT (with refresh) for security.
|
||||
- Allows for adding new twts and directly editing a `twtxt.txt` file from within a browser.
|
||||
- Includes a ull-featured GET API for your `twtxt.txt` file backed by an in-memory cache.
|
||||
- Supports optional drag-and-drop file upload handling with automatic linking.
|
||||
|
||||
## Installing
|
||||
|
||||
```sh
|
||||
yarn add express-twtkpr
|
||||
```
|
||||
|
||||
More to come!
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
Copyright (c) 2026 Eric Woodward, released under the
|
||||
[MIT License](https://www.itsericwoodward.com/licenses/mit/).
|
||||
Reference in New Issue
Block a user