@lightspeed-js/core 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nick Paustian
+
+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,75 @@
+# @lightspeed-js/core
+
+Lightspeed is a compile-first framework for **islands of reactivity**: pages are static HTML generated at build time, and only the parts that need JavaScript hydrate. Components are single-file `.lsp` files with `<view>`, `<logic>` and `<style>` blocks, compiled by a Vite plugin.
+
+> Early release (0.x). The API may change between minor versions.
+
+## Install
+
+```sh
+npm install @lightspeed-js/core
+npm install -D vite typescript
+```
+
+Works with Vite 6, 7 and 8.
+
+## Set up
+
+`vite.config.ts`:
+
+```ts
+import { defineConfig } from 'vite'
+import { lightspeedPlugin } from '@lightspeed-js/core/vite'
+
+export default defineConfig({
+  plugins: [lightspeedPlugin({ typescript: true })],
+})
+```
+
+`src/main.ts`:
+
+```ts
+import { createLightspeedApp } from '@lightspeed-js/core'
+import { components } from 'virtual:lightspeed/components'
+
+const app = createLightspeedApp()
+app.useComponents(components)
+app.hydrate()
+```
+
+Pages are `.html` files at the project root (or in `routes/`) that use components as tags, e.g. `<Header />`. Components live in `src/components/*.lsp`.
+
+## A component
+
+```html
+<view>
+  <button class="counter" @click="state.count++">Clicked {{ state.count }} times</button>
+</view>
+
+<logic lang="ts">
+import { reactive } from '@lightspeed-js/core'
+
+const state = reactive({ count: 0 })
+</logic>
+
+<style>
+  .counter { padding: 0.5rem 1rem; }
+</style>
+```
+
+## Entry points
+
+| Import | For |
+| --- | --- |
+| `@lightspeed-js/core` | Runtime: `createLightspeedApp`, `reactive`, `shared`, `defineProps`, lifecycle hooks |
+| `@lightspeed-js/core/vite` | The Vite plugin |
+| `@lightspeed-js/core/ssg` | Static site generation |
+| `@lightspeed-js/core/compile` | Compile components outside a Vite build (e.g. tests, a CMS) |
+
+## Upgrading from the unpublished `lightspeed` package
+
+Code importing `'lightspeed'` keeps working: component logic accepts both names, and the Vite plugin maps `'lightspeed'` to `@lightspeed-js/core`. Only `vite.config.ts` must change, because Node loads it before the plugin runs: import from `'@lightspeed-js/core/vite'`. New code should use `@lightspeed-js/core`.
+
+## Licence
+
+MIT