Feature/rebrand (#27)

This commit is contained in:
Daniel Lautzenheiser
2022-10-02 20:06:20 -04:00
committed by GitHub
parent 11a684f372
commit 8a59f850d1
117 changed files with 2398 additions and 2272 deletions

View File

@ -1,13 +1,13 @@
<div align="center">
<img src="simple-cms-logo.png" width="500px" />
<img src="static-cms-logo.png" width="500px" />
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/SimpleCMS/simple-cms/blob/main/LICENSE)
[![npm latest package](https://img.shields.io/npm/v/@simplecms/simple-cms-core/latest.svg)](https://www.npmjs.com/package/@simplecms/simple-cms-core)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/SimpleCMS/simple-cms/blob/main/CONTRIBUTING.md)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/StaticJsCMS/static-cms/blob/main/LICENSE)
[![npm latest package](https://img.shields.io/npm/v/@staticcms/core/latest.svg)](https://www.npmjs.com/package/@staticcms/core)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/StaticJsCMS/static-cms/blob/main/CONTRIBUTING.md)
</div>
[simplecms.github.io/simple-cms](https://www.simplecms.github.io/simple-cms/)
[staticjscms.github.io/static-cms](https://www.staticjscms.github.io/static-cms/)
A CMS for static site generators. Give users a simple way to edit
and add content to any site built with a static site generator.
@ -16,7 +16,7 @@ and add content to any site built with a static site generator.
## How It Works
Simple CMS is a single-page app that you pull into the `/admin` part of your site.
Static CMS is a single-page app that you pull into the `/admin` part of your site.
It presents a clean UI for editing content stored in a Git repository.
@ -26,21 +26,21 @@ tweak the main layout of the CMS a bit to fit your own site.
When a user navigates to `/admin/` they'll be prompted to log in, and once authenticated
they'll be able to create new content or edit existing content.
Read more about Simple CMS [Core Concepts](https://www.simplecms.github.io/simple-cms/docs/intro/).
Read more about Static CMS [Core Concepts](https://www.staticjscms.github.io/static-cms/docs/intro/).
# Installation and Configuration
The Simple CMS can be used in two different ways.
The Static CMS can be used in two different ways.
* A Quick and easy install, that requires you to create a single HTML file and a configuration file. All the CMS JavaScript and CSS are loaded from a CDN.
To learn more about this installation method, refer to the [Quick Start Guide](https://www.simplecms.github.io/simple-cms/docs/quick-start/)
To learn more about this installation method, refer to the [Quick Start Guide](https://www.staticjscms.github.io/static-cms/docs/quick-start/)
* A complete, more complex install, that gives you more flexibility but requires that you use a static site builder with a build system that supports npm packages.
# simple-cms-core
# static-cms-core
## Installation
`npm install @simplecms/simple-cms-core`
`npm install @staticcms/core`
## Setup
@ -62,7 +62,7 @@ import {
ListWidget,
MapWidget,
MarkdownWidget,
SimpleCmsCore as CMS,
StaticCmsCore as CMS,
NumberWidget,
ObjectWidget,
ProxyBackend,
@ -74,7 +74,7 @@ import {
locales,
Icon,
images
} from '@simple-cms/simple-cms-core';
} from '@static-cms/static-cms-core';
// Register all the things
CMS.registerBackend('git-gateway', GitGatewayBackend);
@ -117,20 +117,20 @@ Object.keys(images).forEach(iconName => {
# Contributing
New contributors are always welcome! Check out [CONTRIBUTING.md](https://github.com/SimpleCMS/simple-cms/blob/main/CONTRIBUTING.md) to get involved.
New contributors are always welcome! Check out [CONTRIBUTING.md](https://github.com/StaticJsCMS/static-cms/blob/main/CONTRIBUTING.md) to get involved.
# Change Log
This project adheres to [Semantic Versioning](http://semver.org/).
Every release is documented on the Github [Releases](https://github.com/SimpleCMS/simple-cms/releases) page.
Every release is documented on the Github [Releases](https://github.com/StaticJsCMS/static-cms/releases) page.
# License
Simple CMS is released under the [MIT License](LICENSE).
Static CMS is released under the [MIT License](LICENSE).
Please make sure you understand its [implications and guarantees](https://writing.kemitchell.com/2016/09/21/MIT-License-Line-by-Line.html).
# Netlify CMS
Simple CMS is a fork of Netlify CMS focusing on the core product over adding massive new features.
Static CMS is a fork of Netlify CMS focusing on the core product over adding massive new features.
# Thanks