@slicemachine/init 1.1.19-dev-release-feb.2 → 2.0.0

package/README.md

@@ -1,20 +1,91 @@
-<p align="center">
-  <a href="https://slicemachine.dev">
-    <img src="https://raw.githubusercontent.com/prismicio/slice-machine/master/.github/logo.svg" alt="Slice Machine logo" width="220" />
-  </a>
-</p>
-
-# Slice Machine Init
+# @slicemachine/init
 
 [![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
 [![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
+[![Conventional Commits][conventional-commits-src]][conventional-commits-href]
 [![License][license-src]][license-href]
 
+The easiest way to add Slice Machine to your project.
+
+- 🏗️ &nbsp;Installs [Slice Machine][slice-machine] as a development dependency.
+- 🪄 &nbsp;Automatically detects and installs the correct framework adapter ([Next.js][nextjs] and [Nuxt][nuxt] are supported).
+- ✏️ &nbsp;Walks you through creating a new [Prismic][prismic] content repository.
+
+## Quick Start
+
+First, create a [Next.js][nextjs] or [Nuxt][nuxt] app if you don't already have one:
+
+```sh
+npx create-next-app
+
+# or
+
+npx nuxi init your-app-name
+```
+
+Then, run `@slicemachine/init`:
+
+```sh
+cd your-app-name
+npx @slicemachine/init
+```
+
+Slice Machine is now ready to run!
+
+```sh
+npm run slicemachine
+```
+
+## Documentation
+
+For full documentation, visit the [official Prismic documentation][prismic-docs-slice-machine].
+
+## Contributing
+
+Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!
+
+**Asking a question**: [Open a new topic][forum-question] on our community forum explaining what you want to achieve / your question. Our support team will get back to you shortly.
+
+**Reporting a bug**: [Open an issue][repo-bug-report] explaining your application's setup and the bug you're encountering.
+
+**Suggesting an improvement**: [Open an issue][repo-feature-request] explaining your improvement or feature so we can discuss and learn more.
+
+**Submitting code changes**: For small fixes, feel free to [open a PR][repo-pull-requests] with a description of your changes. For large changes, please first [open an issue][repo-feature-request] so we can discuss if and how the changes should be implemented.
+
+## License
+
+```
+   Copyright 2013-2023 Prismic <contact@prismic.io> (https://prismic.io)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+```
+
 <!-- Links -->
 
 [prismic]: https://prismic.io
+[slice-machine]: https://prismic.io/slice-machine
+[nextjs]: https://nextjs.org/
+[nuxt]: https://nuxt.com/
+
+<!-- TODO: Replace link with a more useful one if available -->
+
 [prismic-docs]: https://prismic.io/docs
+[prismic-docs-slice-machine]: https://prismic.io/docs/slice-machine
 [changelog]: /CHANGELOG.md
+
+<!-- TODO: Replace link with a more useful one if available -->
+
 [forum-question]: https://community.prismic.io
 [repo-bug-report]: https://github.com/prismicio/slice-machine/issues/new?assignees=&labels=bug&template=bug_report.md&title=
 [repo-feature-request]: https://github.com/prismicio/slice-machine/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
@@ -22,30 +93,15 @@
 
 <!-- Badges -->
 
-[npm-version-src]: https://img.shields.io/npm/v/@slicemachine/init/latest.svg
-[npm-version-href]: https://npmjs.com/package/@slicemachine/init
+[npm-version-src]: https://img.shields.io/npm/v/start-slicemachine/latest.svg
+[npm-version-href]: https://npmjs.com/package/start-slicemachine
+[npm-downloads-src]: https://img.shields.io/npm/dm/start-slicemachine.svg
+[npm-downloads-href]: https://npmjs.com/package/start-slicemachine
 [github-actions-ci-src]: https://github.com/prismicio/slice-machine/workflows/test/badge.svg
 [github-actions-ci-href]: https://github.com/prismicio/slice-machine/actions?query=workflow%3Atest
-[license-src]: https://img.shields.io/npm/l/slice-machine-ui.svg
-[license-href]: https://npmjs.com/package/slice-machine-ui
-
-Slice Machine Init is the easiest way to add Slice Machine to your project.
-
-Slice Machine Init works on macOS, Windows, and Linux.  
-If something does not work, please [file an issue](https://github.com/prismicio/slice-machine/issues/new).
-
-## Quick Overview
-
-```
-cd my-app
-npx @slicemachine/init
-npm run slicemachine
-```
-
-_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher)_
-
-Then open http://localhost:9999 to see the Slice Machine.
-
-<p align='center'>
-    <img src='https://raw.githubusercontent.com/prismicio/slice-machine/master/.github/init-preview.png' width='600'>
-</p>
+[codecov-src]: https://img.shields.io/codecov/c/github/prismicio/slice-machine.svg
+[codecov-href]: https://codecov.io/gh/prismicio/slice-machine
+[conventional-commits-src]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
+[conventional-commits-href]: https://conventionalcommits.org
+[license-src]: https://img.shields.io/npm/l/start-slicemachine.svg
+[license-href]: https://npmjs.com/package/start-slicemachine

package/bin/slicemachine-init.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import("../dist/cli.cjs");