mintlify 1.0.9 → 1.1.0

package/README.md

@@ -1,31 +1,53 @@
-# Mintlify CLI
-
-The Mintlify CLI is used to automate migrations.
-
-## Installation
-
-`npm i -g mintlify`
-
-If you installed a local version, you may need to uninstall it with
-
-`npm uninstall -g mintlify` before installing the published version.
-
-## Local development & testing
-
-To test changes locally run:
-
-`npm run local`
-
-## Commands
-
-### Migrations
-
-We support automated migrations from ReadMe, GitBook, and Docusaurus.
-
-`mintlify scrape-page <url>` - Scrapes the page at the URL provided and creates a corresponding MDX file
-
-`mintlify scrape-section <url>` - Scrapes the section at the URL provided and creates the MDX files within that section
-
-#### Options
-
-`--overwrite` - By default if an existing file with the same path name is detected, the file will not be overwritten by the scraper. Use this option to force an overwrite.
+<div align="center">
+  <a href="https://mintlify.com">
+    <img
+      src="https://res.cloudinary.com/mintlify/image/upload/v1665385627/logo-rounded_zuk7q1.svg"
+      alt="Mintlify Logo"
+      height="64"
+    />
+  </a>
+  <br />
+  <p>
+    <h3>
+      <b>
+        Mintlify CLI
+      </b>
+    </h3>
+  </p>
+  <p>
+    The Mintlify CLI is the easiest way to build Mintlify apps from the command line.
+  </p>
+  <p>
+
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?logo=github)](/) [![Website](https://img.shields.io/website?url=https%3A%2F%2Fmintlify.com&logo=mintlify)](https://mintlify.com) [![Tests](https://github.com/mintlify/mint/actions/workflows/manual.yml/badge.svg)](https://github.com/mintlify/mint/actions) [![Tweet](https://img.shields.io/twitter/url?url=https%3A%2F%2Fmintlify.com%2F)](https://twitter.com/intent/tweet?url=&text=Check%20out%20%40mintlify) [![Chat on Discord](https://img.shields.io/badge/chat-Discord-7289DA?logo=discord)](https://discord.gg/MPNgtSZkgK) [![Discuss on GitHub](https://img.shields.io/badge/discussions-GitHub-333333?logo=github)](https://github.com/mintlify/mint/discussions)
+
+  </p>
+  <p>
+    <sub>
+      Built with ❤︎ by
+      <a href="https://mintlify.com">
+        Mintlify
+      </a>
+    </sub>
+  </p>
+</div>
+
+### 🚀 Installation
+
+Download the Mintlify CLI using the following command
+
+```
+npm i mintlify -g
+```
+
+### 👩‍💻 Development
+
+Run the following command at the root of your Mintlify application to preview changes locally.
+
+```
+mintlify dev
+```
+
+### 🏃 Get Started
+
+[Create an account](https://mintlify.com/start) to start using Mintlify for your documentation.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mintlify",
-  "version": "1.0.9",
+  "version": "1.1.0",
   "description": "The Mintlify CLI",
   "engines": {
     "node": ">=14.16"