diff --git a/.changeset/rude-pears-hammer.md b/.changeset/rude-pears-hammer.md new file mode 100644 index 000000000000..5185d07d4447 --- /dev/null +++ b/.changeset/rude-pears-hammer.md @@ -0,0 +1,5 @@ +--- +'create-svelte': patch +--- + +[feat] remove release candidate banner diff --git a/README.md b/README.md index b9d068c73181..fb5282e9f4e7 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,31 @@ [![Chat](https://img.shields.io/discord/457912077277855764?label=chat&logo=discord)](https://svelte.dev/chat) -# READ THIS FIRST! +# SvelteKit -SvelteKit is in its release candidate phase: -- :exclamation: expect bugs! -- :heavy_check_mark: no more planned breaking changes -- :heavy_check_mark: countdown to a stable release -- :x: feature-complete -- :x: tutorials - -Watch [the announcement](https://www.youtube.com/watch?v=A8jkJTWacow&t=29628s) and track [progress towards 1.0](https://github.com/sveltejs/kit/issues?q=is%3Aopen+is%3Aissue+milestone%3A1.0) for more details. - -## Overview - -The Fastest Way to Build Svelte Apps - -- 💨 Blazing-Fast Production Sites -- 🛠️ SSR, SPA, SSG, and In-Between -- ⚡️ Instantly Visible Code Changes -- 🔩 Existing Universe of Plugins -- 🔑 Fully Typed APIs - -## Documentation - -Please see [the documentation](https://kit.svelte.dev/docs) for information about getting started and developing with SvelteKit. +Web development, streamlined. Read the [documentation](https://kit.svelte.dev/docs) to get started. ### Packages | Package | Changelog | | --------------------------------------------------------------------------- | ------------------------------------------------------------- | | [@sveltejs/kit](packages/kit) | [Changelog](packages/kit/CHANGELOG.md) | -| [create-svelte](packages/create-svelte) | [Changelog](packages/create-svelte/CHANGELOG.md) | -| [@sveltejs/adapter-node](packages/adapter-node) | [Changelog](packages/adapter-node/CHANGELOG.md) | -| [@sveltejs/adapter-static](packages/adapter-static) | [Changelog](packages/adapter-static/CHANGELOG.md) | -| [@sveltejs/adapter-cloudflare-workers](packages/adapter-cloudflare-workers) | [Changelog](packages/adapter-cloudflare-workers/CHANGELOG.md) | +| [@sveltejs/adapter-auto](packages/adapter-auto) | [Changelog](packages/adapter-auto/CHANGELOG.md) | | [@sveltejs/adapter-cloudflare](packages/adapter-cloudflare) | [Changelog](packages/adapter-cloudflare/CHANGELOG.md) | +| [@sveltejs/adapter-cloudflare-workers](packages/adapter-cloudflare-workers) | [Changelog](packages/adapter-cloudflare-workers/CHANGELOG.md) | | [@sveltejs/adapter-netlify](packages/adapter-netlify) | [Changelog](packages/adapter-netlify/CHANGELOG.md) | +| [@sveltejs/adapter-node](packages/adapter-node) | [Changelog](packages/adapter-node/CHANGELOG.md) | +| [@sveltejs/adapter-static](packages/adapter-static) | [Changelog](packages/adapter-static/CHANGELOG.md) | | [@sveltejs/adapter-vercel](packages/adapter-vercel) | [Changelog](packages/adapter-vercel/CHANGELOG.md) | +| [@sveltejs/amp](packages/amp) | [Changelog](packages/amp/CHANGELOG.md) | +| [@sveltejs/package](packages/package) | [Changelog](packages/package/CHANGELOG.md) | +| [create-svelte](packages/create-svelte) | [Changelog](packages/create-svelte/CHANGELOG.md) | +| [svelte-migrate](packages/migrate) | [Changelog](packages/migrate/CHANGELOG.md) | -The SvelteKit community also makes additional [SvelteKit adapters available for use](https://sveltesociety.dev/components#adapters). - -### Migrating from Sapper - -Check out the [Migration Guide](https://kit.svelte.dev/docs/migrating) if you are upgrading from Sapper. - -## Bug reporting - -Please make sure the issue you're reporting involves SvelteKit. Many issues related to how a project builds originate from [Vite](https://vitejs.dev/), which is used to build a SvelteKit project. It's important to note that new Vite projects don't use SSR by default, and so if you create a new Vite project from scratch, many issues won't reproduce. You should thus start with a project that utilizes SSR, such as `npm create vite-extra@latest -- --template ssr-svelte`. - -If an issue originates from Vite, please report it in the [Vite issue tracker](https://github.com/vitejs/vite/issues). +[Additional adapters](<(https://sveltesociety.dev/components#adapters)>) are maintained by the community. -## Changing SvelteKit locally +## Contributing -See the [Contributing Guide](./CONTRIBUTING.md). +See [CONTRIBUTING.md](./CONTRIBUTING.md) for information on how to develop SvelteKit locally. ## Supporting Svelte diff --git a/documentation/docs/10-getting-started/10-introduction.md b/documentation/docs/10-getting-started/10-introduction.md index 8159e26aee00..a6a4476280be 100644 --- a/documentation/docs/10-getting-started/10-introduction.md +++ b/documentation/docs/10-getting-started/10-introduction.md @@ -4,15 +4,15 @@ title: Introduction ## Before we begin -> SvelteKit is in release candidate phase for 1.0 while we address reported issues and add polish. If you get stuck, reach out for help in the [Discord chatroom](https://svelte.dev/chat). +> If you're new to Svelte or SvelteKit we recommend checking out the (experimental!) [interactive tutorial](https://learn.svelte.dev). > -> See the [migration guides](/docs/migrating) for help upgrading from Sapper. +> If you get stuck, reach out for help in the [Discord chatroom](https://svelte.dev/chat). ## What is SvelteKit? -SvelteKit is a framework for building extremely high-performance web apps. +SvelteKit is a framework for rapid development of robust, performant web applications. -Building an app with all the modern best practices is fiendishly complicated. Those practices include [build optimizations](https://vitejs.dev/guide/features.html#build-optimizations), so that you load only the minimal required code; [offline support](/docs/service-workers); [preloading](/docs/link-options#data-sveltekit-preload-data) pages before the user initiates navigation; and [configurable rendering](/docs/page-options) that allows you to render your app [on the server](/docs/glossary#ssr) or [in the browser](/docs/glossary#csr-and-spa) at runtime or [at build-time](/docs/glossary#prerendering). SvelteKit does all the boring stuff for you so that you can get on with the creative part. +Building an app with all the modern best practices is fiendishly complicated. Those practices include [build optimizations](https://vitejs.dev/guide/features.html#build-optimizations), so that you load only the minimal required code; [offline support](/docs/service-workers); [preloading](/docs/link-options#data-sveltekit-preload-data) pages before the user initiates navigation; [configurable rendering](/docs/page-options) that allows you to render your app [on the server](/docs/glossary#ssr) or [in the browser](/docs/glossary#csr-and-spa) at runtime or [at build-time](/docs/glossary#prerendering); and many other things. SvelteKit does all the boring stuff for you so that you can get on with the creative part. It uses [Vite](https://vitejs.dev/) with a [Svelte plugin](https://github.com/sveltejs/vite-plugin-svelte) to provide a lightning-fast and feature-rich development experience with [Hot Module Replacement (HMR)](https://github.com/sveltejs/vite-plugin-svelte/blob/main/docs/config.md#hot), where changes to your code are reflected in the browser instantly. diff --git a/documentation/faq/10-version-numbers.md b/documentation/faq/10-version-numbers.md deleted file mode 100644 index 143956b57e01..000000000000 --- a/documentation/faq/10-version-numbers.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: SvelteKit is not 1.0 yet. Should I use it? ---- - -SvelteKit is currently in release candidate phase. We expect minimal to no breaking changes and for development to be focused on bug fixes. diff --git a/packages/create-svelte/bin.js b/packages/create-svelte/bin.js index 32db8d6e08e9..c3447a7f0630 100755 --- a/packages/create-svelte/bin.js +++ b/packages/create-svelte/bin.js @@ -9,10 +9,6 @@ import { dist } from './utils.js'; // prettier-ignore const disclaimer = ` ${bold(cyan('Welcome to SvelteKit!'))} - -${bold(red('This is release candidate software; expect bugs and missing features.'))} - -Problems? Open an issue on ${cyan('https://github.com/sveltejs/kit/issues')} if none exists already. `; const { version } = JSON.parse(fs.readFileSync(new URL('package.json', import.meta.url), 'utf-8')); @@ -180,7 +176,7 @@ async function main() { console.log(` ${i++}: ${bold(cyan('npm run dev -- --open'))}`); console.log(`\nTo close the dev server, hit ${bold(cyan('Ctrl-C'))}`); - console.log(`\nStuck? Visit us at ${cyan('https://svelte.dev/chat')}\n`); + console.log(`\nStuck? Visit us at ${cyan('https://svelte.dev/chat')}`); } main();