@nectar-js/nectar 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Tiago Mouta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,53 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/nectar-js/nectar/main/assets/NectarFullSmall.png" alt="Nectar" width="192" />
+</p>
+
+<h1 align="center">Nectar</h1>
+
+<p align="center">A filesystem-based meta-framework for discord.js.</p>
+
+<br />
+
+Nectar is a framework for Discord bots. You define commands, components, and events as files under `app/`, and Nectar handles command registration, custom ID encoding, and interaction routing.
+
+`app/commands/ping/command.ts` registers `/ping`, and `app/commands/moderation/ban/command.ts` registers `/moderation ban`. `app/components/tickets/[ticketId]/close/button.ts` handles a button whose custom ID carries a typed `ticketId`. Handlers get the discord.js interaction and client.
+
+```bash
+npm create @nectar-js
+```
+
+```ts
+// app/commands/ping/command.ts  ->  /ping
+import { type CommandMeta, defineCommand } from "@nectar-js/nectar";
+
+export const meta: CommandMeta = { description: "Check if the bot is alive" };
+
+export default defineCommand("ping", async (ctx) => {
+  await ctx.interaction.reply("Pong.");
+});
+```
+
+```bash
+nectar dev      # run the bot, reloading handlers on save
+nectar build    # compile to .nectar/
+nectar sync     # register commands with Discord
+nectar start    # run the compiled build
+```
+
+`nectar --help` lists the rest. The documentation is at [nectar-js.github.io/nectar](https://nectar-js.github.io/nectar/).
+
+## Status
+
+Nectar is at 0.x and changes often. Minor versions can break things, so read the [changelog](https://github.com/nectar-js/nectar/blob/main/packages/nectar/CHANGELOG.md) before upgrading.
+
+## Requirements
+
+Node.js 22.18 or newer, ESM, discord.js v14. JavaScript projects are supported; the generated route types are TypeScript-only.
+
+## Contributing
+
+See [CONTRIBUTING.md](https://github.com/nectar-js/nectar/blob/main/CONTRIBUTING.md).
+
+## License
+
+MIT. See [LICENSE](https://github.com/nectar-js/nectar/blob/main/LICENSE).