@sveltia/cms 0.8.1 → 0.8.3

package/README.md

@@ -1,20 +1,20 @@
 # Sveltia CMS
 
-Sveltia CMS is a Git-based lightweight headless CMS under active development as a drop-in replacement for [Netlify/Decap CMS](https://decapcms.org/). You can use it with your favourite static site generator like SvelteKit, Eleventy, Next.js and Hugo to manage content as static files in a Git repository. The open source alternative to Netlify/Decap CMS is now in public beta — with more features to come.
+Sveltia CMS is a Git-based lightweight headless CMS under active development as a modern, quick replacement for [Netlify/Decap CMS](https://decapcms.org/). You can use it with your favourite static site generator like SvelteKit, Eleventy, Next.js and Hugo to manage content as static files in a Git repository. The free open source alternative to Netlify/Decap CMS is now in public beta — with more features to come.
 
 ![Screenshot: Git-based Headless CMS with Dark Mode](docs/screenshot-20231120-1.webp)<br>
 
 ![Screenshot: Instant Entry Listing, Searching and Saving](docs/screenshot-20231120-2.webp)<br>
 
-![Screenshot: Stock Photo Integration](docs/screenshot-20231120-3.webp)<br>
+![Screenshot: Stock Photo Integration with Pexels, Pixabay and Unsplash](docs/screenshot-20231120-3.webp)<br>
 
-![Screenshot: All-New Asset Library; Full Internationalization Support](docs/screenshot-20231120-4.webp)<br>
+![Screenshot: All-New Asset Library; Full Internationalization Support with DeepL](docs/screenshot-20231120-4.webp)<br>
 
-![Screenshot: Single-Line Migration from Netlify/Decap CMS](docs/screenshot-20231120-5.webp)<br>
+![Screenshot: Single-Line Migration from Netlify/Decap CMS (depending on your current setup)](docs/screenshot-20231120-5.webp)<br>
 
 ## Motivation
 
-Sveltia CMS was born in November 2022, when the progress of Netlify CMS was stalled for more than six months. [@kyoshino](https://github.com/kyoshino)’s clients wanted to replace their Netlify CMS instances without much effort, mainly to get better internationalization support.
+Sveltia CMS was born in November 2022, when the progress of Netlify CMS was stalled for more than six months. [@kyoshino](https://github.com/kyoshino)’s clients wanted to replace their Netlify CMS instances without much effort, mainly to get better internationalization (i18n) support.
 
 To achieve radical improvements in UX, performance and i18n, it was decided to build an alternative from the ground up, while ensuring an easy migration path from the other. After proving the concept with a rapid [Svelte](https://svelte.dev/) prototype, development was accelerated to address their primary use cases. The new offering has since been released as open source software to encourage wider adoption.
 
@@ -27,23 +27,23 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
 ### Compatible with Netlify/Decap CMS
 
 - Ready to replace Netlify/Decap CMS _in some casual use case scenarios_ by updating a single line of code.
-- Existing [configuration files](https://decapcms.org/docs/configuration-options/) can be reused as is.
-- Various features are still missing though — [see the compatibility chart below](#compatibility) for details.
+- Your existing [configuration file](https://decapcms.org/docs/configuration-options/) can be reused as is.
+- Various features are still missing though — look at the [compatibility chart](#compatibility) below to see if you can migrate.
 
 ### Better UX
 
-- Created and maintained by an [experienced UX engineer](https://github.com/kyoshino) who loves code and design. You can expect constant UX improvements.
+- Created and maintained by an [experienced UX engineer](https://github.com/kyoshino) who loves code and design. You can expect constant UX improvements across the platform.
 - Offers a modern, intuitive user interface, including an immersive dark mode[^2], inspired in part by the Netlify CMS v3 prototype[^1].
-- Comes with touch device support. While the UI is not yet optimized for smaller screens, larger tablets like iPad Pro or Pixel Tablet should work well.
+- Comes with touch device support. While the UI is not yet optimized for small screens, large tablets like iPad Pro or Pixel Tablet should work well.
 - The screenshots above are worth a thousand words!
 
 ### Better performance
 
 - Built completely from scratch with Svelte instead of forking React-based Netlify/Decap CMS. The app starts fast and stays fast. The compiled code is vanilla JavaScript — you can use it with almost any framework.
+- Small footprint: less than 300 KB when minified and gzipped, compared to 1.5 MB of Netlify/Decap CMS. And [no virtual DOM overhead](https://svelte.dev/blog/virtual-dom-is-pure-overhead).
 - Uses the GraphQL API for GitHub to quickly fetch content at once, so that entries and assets can be listed and searched instantly. This avoids the slowness and potential API rate limit violations caused by hundreds of requests with relation widgets[^14].
 - Saving entries and assets is also much faster thanks to the [GraphQL mutation](https://github.blog/changelog/2021-09-13-a-simpler-api-for-authoring-commits/).
 - Caches Git files locally to further speed up startup and reduce bandwidth.
-- Small footprint: less than 300 KB when minified and gzipped, compared to 1.5 MB of Netlify/Decap CMS. And [no virtual DOM overhead](https://svelte.dev/blog/virtual-dom-is-pure-overhead).
 
 ### Better productivity
 
@@ -81,12 +81,12 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
 
 - Required fields, not optional fields, are clearly marked for efficient data entry.
 - Integration with Pexels, Pixabay and Unsplash makes it easy to insert free stock photos into image fields[^8].
-- Optional object fields (`widget:object` with `required:false`) can be manually added or removed. If removed, the required subfields will no longer trigger validation errors[^16].
+- Optional object fields (`widget: object` with `required: false`) can be manually added or removed. If removed, the required subfields will no longer trigger validation errors[^16].
 - You can revert changes to all fields or a specific field.
 
 ### Asset Library enhancements
 
-- An all-new Asset Library makes it easy to manage all your files, including images and documents.
+- A completely new Asset Library, built separately from the image selection dialog, makes it easy to manage all of your files, including images and documents.
 - You can sort or filter assets by name or file type and view asset details, including size, dimensions, and a list of entries that use the selected asset.
 - You can upload multiple assets at once, including files in nested folders, by browsing or dragging & dropping them into the media library[^5].
 - You can navigate between the global media folder and a per-collection media folder[^6].
@@ -99,9 +99,9 @@ While it’s not our goal to recreate all the features found in Netlify/Decap CM
 | --- | --- |
 | Installation | Installing with npm is not supported yet. |
 | UI locales | Only English and Japanese are available at this time. No registration is needed. While the UI locale is automatically selected depending on the browser’s language settings, it can be changed in Settings. (Click on the Account button in the top right corner of the CMS.) |
-| Account | Only the [GitHub backend](https://decapcms.org/docs/github-backend/) is available at this time. You can keep using Netlify or a [3rd party OAuth client](https://decapcms.org/docs/external-oauth-clients/) (or [our own](https://github.com/sveltia/sveltia-cms-auth)) to sign in with GitHub, just like Netlify/Decap CMS. The GitLab backend is coming soon. We plan to add the Test backend as well for our demo site, but Azure and Bitbucket are unlikely to be supported, mainly due to the lack of an API method to fetch content in bulk. Later we may implement a performant Git Gateway alternative using GraphQL. |
+| Account | Only the [GitHub backend](https://decapcms.org/docs/github-backend/) is available at this time. You can keep using Netlify or a [3rd party OAuth client](https://decapcms.org/docs/external-oauth-clients/) (or [our own](https://github.com/sveltia/sveltia-cms-auth)) to sign in with GitHub, just like Netlify/Decap CMS. The GitLab backend is coming soon. We plan to add the Test backend as well for our demo site, but Azure, Bitbucket and Git Gateway will probably not be supported, mainly due to the lack of a method to fetch content in bulk. We have not looked into the relatively new Gitea backend yet. Later we may implement a performant Git Gateway alternative using GraphQL. |
 | Configuration | Supported. |
-| Media | External media storage services are not supported yet. |
+| Media | External media storage services are not supported yet. Deprecated Netlify Large Media won’t be added. |
 | Editorial Workflow | Not supported yet. |
 | Collections | Supported. |
 | Widgets | [See below](#widget-limitations) for the current limitations. |
@@ -113,19 +113,19 @@ While it’s not our goal to recreate all the features found in Netlify/Decap CM
 | Widget | Status in Sveltia CMS |
 | --- | --- |
 | Code | Not supported yet. |
-| Color | It’s a native `<input>` element at this time. The `enableAlpha` option is not supported yet. |
-| Date/DateTime | These are also native `<input>` elements. The `date_format` and `time_format` options with Moment.js tokens are not supported yet. We may deprecate the Moment.js format support anyway. |
+| Color | The `enableAlpha` option is not supported yet. |
+| Date/DateTime | The `date_format` and `time_format` options with Moment.js tokens are not supported yet. We may deprecate the Moment.js format support anyway. |
 | File/Image | Field-specific media folders and media library options are not supported yet other than `media_library.config.max_file_size` for the default media library. |
 | Map | Not supported yet. |
 | Markdown | It’s a plain text editor at this time. A rich text editor is coming soon. |
-| Relation | The `search_fields` options is not supported yet. |
+| Relation | The `search_fields` option is not supported yet. |
 
 ### Beta features in Netlify/Decap CMS
 
 | Feature | Status in Sveltia CMS |
 | --- | --- |
 | Working with a Local Git Repository | Supported. [See below](#work-with-a-local-git-repository) for details. |
-| GitLab and BitBucket Editorial Workflow Support | The GitLab backend is not supported yet. No plan to support BitBucket. |
+| GitLab and BitBucket Editorial Workflow Support | Editorial workflow is not supported yet. |
 | i18n Support | Supported. In fact, i18n is at the core of Sveltia CMS! |
 | GitHub GraphQL API | Supported. Sveltia CMS uses GraphQL by default for a better performance. It cannot be disabled. |
 | GitLab GraphQL API | The GitLab backend is not supported yet. |
@@ -168,7 +168,7 @@ While it’s not our goal to recreate all the features found in Netlify/Decap CM
 
 ### New users
 
-Currently, Sveltia CMS is aimed at existing Netlify/Decap CMS users. If you don’t have it yet, follow [their documentation](https://decapcms.org/docs/add-to-your-site/) to add it to your site and create a configuration file first. Then migrate to Sveltia CMS as described below.
+Currently, Sveltia CMS is only intended for existing Netlify/Decap CMS users. If you don’t have it yet, follow [their documentation](https://decapcms.org/docs/add-to-your-site/) to add it to your site and create a configuration file first. Then migrate to Sveltia CMS as described below.
 
 As the product evolves, we’ll implement a built-in configuration editor and provide comprehensive documentation to make it easier for everyone to get started with Sveltia CMS.
 
@@ -179,7 +179,7 @@ Here are some starter kits for popular frameworks created by community members.
 
 ### Migration
 
-If you’re already using Netlify/Decap CMS with the GitHub backend and don’t have any custom widget, custom preview or plugin, migrating to Sveltia CMS is super easy. Edit `/admin/index.html` to replace the CMS `script` tag, and push the change to your repository:
+Have a look at the [compatibility chart](#compatibility) above first. If you’re already using Netlify/Decap CMS with the GitHub backend and don’t have any custom widget, custom preview or plugin, migrating to Sveltia CMS is super easy. Edit `/admin/index.html` to replace the CMS `script` tag, and push the change to your repository:
 
 ```diff
 -<script src="https://unpkg.com/netlify-cms@^2.0.0/dist/netlify-cms.js"></script>
@@ -205,11 +205,12 @@ You can use Sveltia CMS with a local Git repository, like the [beta feature](htt
 1. Click “Work with Local Repository” and select the project’s root directory once prompted.
 1. Make some changes to your content on Sveltia CMS.
 1. See if the produced changes look good using `git diff` or a GUI like [GitHub Desktop](https://desktop.github.com/).
+1. Open the dev site at `http://localhost:[port]/` to check the rendered results.
 1. Commit and push the changes if satisfied, or discard them if you’re just testing.
 
 ### Use a custom icon for a collection
 
-As shown in the screenshot above, you can use different icons for collections in Sveltia CMS.
+You can have an icon for each collection for easy identification in the collection list.
 
 1. Visit the [Material Symbols](https://fonts.google.com/icons?icon.set=Material+Symbols&icon.platform=android) page on Google Fonts.
 1. Search and select an icon, and copy the icon name displayed on the right panel.