Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: update package readme #6870

Merged
merged 1 commit into from
Aug 18, 2023
Merged

feat: update package readme #6870

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 14 additions & 23 deletions packages/decap-cms/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# Decap 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.

[decapcms.org](https://www.decapcms.org/)

## Community Chat

<a href="https://decapcms.org/chat">
<img alt="Join us on Discord" src="https://raw.githubusercontent.com/decaporg/decap-cms/master/website/static/img/discord.png" width="165">
</a>
<a href="https://decapcms.org/chat">Join us on Discord</a>

## How it works
## How It Works

Decap CMS is a single-page app that you pull into the `/admin` part of your site.

Expand All @@ -17,43 +18,33 @@ It presents a clean UI for editing content stored in a Git repository.
You setup a YAML config to describe the content model of your site, and typically
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 login, and once authenticated
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 Decap CMS [Core Concepts](https://www.decapcms.org/docs/intro/).

# Installation and Configuration
## Installation and Configuration

The Decap CMS can be used in two different ways.

* A Quick and easy install, that just requires you to create a single HTML file and a configuration file. All the CMS Javascript and CSS are loaded from a CDN.
* 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.decapcms.org/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.

# Contributing
## Contributing

New contributors are always welcome! Check out [CONTRIBUTING.md](https://github.com/decaporg/decap-cms/blob/master/CONTRIBUTING.md) to get involved.

# Change Log
## Change Log

This project adheres to [Semantic Versioning](http://semver.org/).
Every release is documented on the Github [Releases](https://github.com/decaporg/decap-cms/releases) page.

# License
## License

Decap 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).

# Thanks

## Services
These services support Decap CMS development by providing free infrastructure.
<p>
<a href="https://www.travis-ci.org">
<img src="https://raw.githubusercontent.com/decaporg/decap-cms/master/img/travis.png" height="38"/>
</a>
<img src="https://spacergif.org/spacer.gif" width="20"/>
<a href="https://www.browserstack.com">
<img src="https://raw.githubusercontent.com/decaporg/decap-cms/master/img/browserstack.png" height="38"/>
</a>
</p>
## Maintainers

Maintained with care by <a href="https://techhub.p-m.si/">PM</a> & friends.
Loading