decap-cms-app 2.16.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2016 Netlify <decap@p-m.si>
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,47 @@
1
+ # Decap CMS App
2
+ _For a Decap CMS overview, see the general [Decap CMS project README](https://github.com/decaporg/decap-cms)._
3
+
4
+ ## Community Chat
5
+
6
+ <a href="https://decapcms.org/chat">
7
+ <img alt="Join us on Discord" src="https://raw.githubusercontent.com/decaporg/decap-cms/master/website/static/img/discord.png" width="165">
8
+ </a>
9
+
10
+ ## Purpose
11
+ This package is similar to the [`decap-cms`](https://github.com/decaporg/decap-cms/tree/master/packages/decap-cms/) package, but is designed for use with extensions. It serves that purpose in the following ways.
12
+
13
+ - It does not automatically initialize - you must run the CMS `init` method.
14
+ - It does not include `react` or `react-dom` - they are required as peer dependencies.
15
+ - It does not include the following extensions:
16
+ - [`decap-cms-media-library-cloudinary`]
17
+ - [`decap-cms-media-library-uploadcare`]
18
+
19
+ ## Usage
20
+ Install via script tag:
21
+
22
+ ```html
23
+ <!-- Excluding `doctype` and `head` but you should add them -->
24
+ <body>
25
+ <!-- Add these scripts to the bottom of the body -->
26
+ <script src="https://unpkg.com/react@^16/umd/react.production.min.js"></script>
27
+ <script src="https://unpkg.com/react-dom@^16/umd/react-dom.production.min.js"></script>
28
+ <script src="https://unpkg.com/decap-cms-app/dist/decap-cms-app.js"></script>
29
+
30
+ <!-- Initialize the CMS -->
31
+ <script>
32
+ DecapCmsApp.init();
33
+ </script>
34
+ </body>
35
+ ```
36
+
37
+ Install via npm:
38
+
39
+ ```
40
+ npm i react react-dom decap-cms-app
41
+ ```
42
+
43
+ ```js
44
+ import CMS from 'decap-cms-app';
45
+
46
+ CMS.init();
47
+ ```