@sveltia/cms 0.1.7 → 0.2.0

package/README.md

@@ -1,6 +1,6 @@
 # Sveltia CMS
 
-Sveltia CMS is a Git-based lightweight headless CMS partially compatible with [Netlify/Decap CMS](https://decapcms.org/). You can use it with any static site generator, such as SvelteKit, Next.js and Hugo, if the content is managed on a Git repository. The product is now in public beta, with more features to come.
+Sveltia CMS is a Git-based lightweight headless CMS partially compatible with [Netlify/Decap CMS](https://decapcms.org/). You can use it with any static site generator, such as SvelteKit, Next.js and Hugo, to manage the content as static files on a Git repository. The product is now in public beta, with more features to come.
 
 ![Screenshot: Git-based Headless CMS with Dark Mode](docs/screenshot-1.jpg)<br>
 
@@ -14,6 +14,12 @@ Sveltia CMS is a Git-based lightweight headless CMS partially compatible with [N
 
 ## Features
 
+Sveltia CMS is a Git-based lightweight headless CMS, which means:
+
+- Git-based: Your content is saved as static JSON, YAML or TOML files on a Git repository. No database or API is involved.
+- Lightweight: The app is compiled as a single small JavaScript file served via a CDN. You don’t have to sign up for a service or install the software.
+- Headless: The CMS only takes care of raw data. You can read it and render the final content with your favourite framework.
+
 Here are some highlights mainly compared to Netlify/Decap CMS:
 
 ### Compatible with Netlify/Decap CMS
@@ -26,6 +32,7 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
 
 - Offering a modern, intuitive UI, with some inspiration from the Netlify/Decap CMS v3 prototype[^1].
 - Immersive dark mode[^2].
+- The screenshots above are worth a thousand words!
 
 ### Better performance
 
@@ -56,12 +63,12 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
 ### Media library enhancements
 
 - A whole new media library makes it easier to manage all your assets.
-- You can upload multiple assets at once, including files in nested folders, by browsing or dragging & dropping them on the media library[^5].
-- You can now navigate between the global media folder and a per-collection media folder[^6] and soon move assets between them.
+- 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 now navigate between the global media folder and a per-collection media folder[^6].
 
 ## Compatibility
 
-While we’re not recreating all the features found in Netlify/Decap CMS, our plan is to gradually expand the compatible areas where possible so that more users can migrate to our alternative.
+While we’re not recreating all the features found in Netlify/Decap CMS, our plan is to gradually expand the compatible areas where possible so that more users can migrate to our modern alternative.
 
 | Feature | Status in Sveltia CMS |
 | --- | --- |
@@ -71,7 +78,7 @@ While we’re not recreating all the features found in Netlify/Decap CMS, our pl
 | Media | External media storage services are not yet supported. |
 | Editorial Workflow | Coming soon. |
 | Collections | Supported. |
-| Widgets | See below. |
+| Widgets | [See below](#widget-limitations) for the current limitations. |
 | Custom widgets | Not yet supported. |
 | Custom previews | Not yet supported. |
 
@@ -100,7 +107,7 @@ While we’re not recreating all the features found in Netlify/Decap CMS, our pl
 | Open Authoring | Not yet supported. |
 | Folder Collections Path | Not yet supported. |
 | Folder Collections Media and Public Folder | Only the _undocumented_, absolute path per-collection folder configuration is currently supported. [See below](#use-a-custom-media-folder-for-a-collection). |
-| List Widget: Variable Types | Coming soon. |
+| List Widget: Variable Types | Supported. |
 | Custom Mount Element | Supported. |
 | Manual Initialization | Not yet supported. |
 | Raw CSS in registerPreviewStyle | Not yet supported. |
@@ -130,7 +137,13 @@ While we’re not recreating all the features found in Netlify/Decap CMS, our pl
 
 ### 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/intro/) to install it and configure your site first. Then migrate to Sveltia CMS as described below.
+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 first. Then migrate to Sveltia CMS as described below.
+
+As the product evolves, we’ll implement the configuration editor and provide comprehensive documentation to make it easier for everyone to get started with Sveltia CMS.
+
+Here are some starter templates for popular frameworks created by our contributors. More to follow!
+
+- [Eleventy](https://github.com/danurbanowicz/eleventy-sveltia-cms-starter) by [@danurbanowicz](https://github.com/danurbanowicz)
 
 ### Migration
 
@@ -143,11 +156,11 @@ If you’re already using Netlify/Decap CMS with the GitHub backend and don’t
 
 That’s it! You can open `https://[hostname]/admin/` as before to start editing. There is even no authentication process if you’ve already been signed in with GitHub on Netlify/Decap CMS because Sveltia CMS uses your auth token stored in the browser. Simple enough!
 
-That said, we highly recommend testing your new Sveltia CMS instance first on your local machine. See below for how.
+That said, we highly recommend testing your new Sveltia CMS instance first on your local machine. [See below](#work-with-a-local-git-repository) for how.
 
 ### Bug Report
 
-Sveltia CMS is still in early beta, so we do expect various bugs. Please [report any bug to us](https://github.com/sveltia/sveltia-cms/issues/new).
+Sveltia CMS is still in early beta, so we do expect various issues. Please [report any bug to us](https://github.com/sveltia/sveltia-cms/issues/new).
 
 ## Tips & tricks
 
@@ -160,7 +173,7 @@ You can host your Sveltia CMS-managed site anywhere, such as [Cloudflare Pages](
 You can use Sveltia CMS with a local Git repository, just like the [beta feature](https://decapcms.org/docs/beta-features/#working-with-a-local-git-repository) in Netlify/Decap CMS, but Sveltia CMS has simplified the workflow by removing the necessity of the additional configuration and proxy server, thanks to the [File System Access API](https://developer.chrome.com/articles/file-system-access/).
 
 1. Launch the local development server for your frontend framework, typically with `npm run dev`.
-1. Visit `http://localhost:[port]/admin/index.html` with [Chrome or Edge](https://developer.mozilla.org/en-US/docs/web/api/window/showopenfilepicker#browser_compatibility).
+1. Visit `http://localhost:[port]/admin/index.html` with [Chrome, Edge or other Chromium-based browser](https://developer.mozilla.org/en-US/docs/web/api/window/showopenfilepicker#browser_compatibility). The port number depends on your framework.
 1. Click “Work with Local Repository” and select the project’s root directory once prompted.
 1. Make some changes on Sveltia CMS.
 1. See if the produced changes look good using `git diff` or a GUI like GitHub Desktop.
@@ -170,8 +183,8 @@ You can use Sveltia CMS with a local Git repository, just like the [beta feature
 
 As shown in the screenshot above, you can use different icons for collections in Sveltia CMS.
 
-1. Visit [Google Fonts](https://fonts.google.com/icons?icon.set=Material+Symbols) and select a Material Symbols icon.
-1. Select the Android tab within the right panel, and copy the icon name.
+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.
 1. Add it to one of your collection definitions in `config.yml` as the new `icon` property, like the example below.
 1. Repeat the same steps for all the collections if desired.
 1. Commit and push the changes to your Git repository.
@@ -218,7 +231,7 @@ Sveltia CMS comes with a handy DeepL integration so that you can translate any t
 
 ### Use a random ID for an entry slug
 
-By default, the [slug for a new entry file](https://decapcms.org/docs/configuration-options/#slug) will be generated based on the entry’s title field. Or, you can specify the collection’s `slug` option to use the file creation date or other fields. While the behavior is generally acceptable and SEO-friendly, it’s not useful if the title might change later or if it contains non-Latin characters like Chinese. In Sveltia CMS, you can easily generate a random [UUID](https://developer.mozilla.org/en-US/docs/Glossary/UUID) without a custom widget!
+By default, the [slug for a new entry file](https://decapcms.org/docs/configuration-options/#slug) will be generated based on the entry’s `title` field. Or, you can specify the collection’s `slug` option to use the file creation date or other fields. While the behaviour is generally acceptable and SEO-friendly, it’s not useful if the title might change later or if it contains non-Latin characters like Chinese. In Sveltia CMS, you can easily generate a random [UUID](https://developer.mozilla.org/en-US/docs/Glossary/UUID) without a custom widget!
 
 It’s simple — just specify `{{uuid}}` (full UUID v4) or `{{uuid_short}}` (last 12 characters only) in the `slug` option. The results would look like `4fc0917c-8aea-4ad5-a476-392bdcf3b642` and `392bdcf3b642`, respectively.
 
@@ -273,17 +286,27 @@ And combine the following policies depending on your Git backend and enabled int
   connect-src https://api.deepl.com;
   ```
 
-## Support
+If you have image field(s) and expect that images will be inserted as URLs, you may want to allow any source using a wildcard instead of specifying individual origins:
 
-Visit the [Discussions](https://github.com/sveltia/sveltia-cms/discussions) page on this GitHub repository.
+```csp
+img-src 'self' blob: data: https://*;
+```
+
+## Support & feedback
+
+Visit the [Discussions](https://github.com/sveltia/sveltia-cms/discussions) page on this GitHub repository and start a new discussion. Tell us your use cases!
 
 ## Contributions
 
-Feel free to [file an issue](https://github.com/sveltia/sveltia-cms/issues/new) for a bug report or feature request! Meanwhile, pull requests are not accepted now due to limited review resources.
+Feel free to [file an issue](https://github.com/sveltia/sveltia-cms/issues/new) for a bug report or feature request! Meanwhile, pull requests can probably not be accepted now due to limited review resources. Things may change in late 2023!
+
+## Links
+
+- Introducing Sveltia CMS: a short presentation by [@kyoshino](https://github.com/kyoshino) during the _This Week in Svelte_ online meetup on March 31, 2023 — [recording](https://youtu.be/-YjLubiieYs?t=1660) & [slides](https://docs.google.com/presentation/d/1Wi4ty-1AwOp2-zy7LctmzCV4rrdYPfke9NGhO0DdRdM)
 
 ## Disclaimer
 
-This software is provided “as is” without any express or implied warranty. This product is not affiliated with Netlify, Decap CMS or any other integrated services. All product names, logos, and brands are the property of their respective owners.
+This software is provided “as is” without any express or implied warranty. This product is not affiliated with or endorsed by Netlify, Decap CMS or any other integrated services. All product names, logos, and brands are the property of their respective owners.
 
 [^1]: [Netlify/Decap CMS #2557](https://github.com/netlify/netlify-cms/issues/2557)
 [^2]: [Netlify/Decap CMS #3267](https://github.com/netlify/netlify-cms/issues/3267)