@magic-circle/styles - npm Package Compare versions

Comparing version 0.1.0-alpha.5 to 0.1.0

package.json

 {
   "name": "@magic-circle/styles",
-  "version": "0.1.0-alpha.5",
+  "version": "0.1.0",
   "description": "Magic Circle style helpers",
@@ -35,3 +35,3 @@ "keywords": [
   "devDependencies": {
-    "@magic-circle/state": "^0.1.0-alpha.5",
+    "@magic-circle/state": "^0.1.0",
     "@types/color-string": "^1.5.2",
@@ -49,3 +49,3 @@ "@types/styled-components": "*",
   },
-  "gitHead": "44142ca8796b9a23646d3d678a54593c789648b6"
+  "gitHead": "5831e685f3fbaca368aeadca53b2af9b77ba5f94"
 }

readme.md

@@ -110,2 +110,27 @@ # ![Logo of Magic Circle](https://raw.github.com/dpwoert/magic-circle/develop/docs/assets/logo.png)
 
+## Settings file
+
+To create your version of magic circle, a settings file is needed. To do see create a new file called `magic.config.js` in the root of your folder.
+
+```js
+export default {
+  // The url to load
+  url: 'http://localhost:4000',
+
+  // Url dependendent on building locally (dev = true) or build for deployment
+  url: (dev) =>
+    dev ? 'http://localhost:4000' : 'https://website.com/visualistion',
+
+  // Load list of plugins, first argument is the default list of plugins
+  // This list can be filtered and extended with custom plugins.
+  plugins: (defaultPlugins) => [...defaultPlugins],
+
+  // Load custom controls
+  controls: (defaultControls) => [...defaultControls],
+
+  // Read plugin pages for specific settings
+  settings: {},
+};
+```
+
 ## Run locally
@@ -136,21 +161,2 @@
 
-## Settings file
-
-```js
-export default {
-  // The url to load
-  url: 'http://localhost:4000',
-
-  // Load list of plugins, first argument is the default list of plugins
-  // This list can be filtered and extended with custom plugins.
-  plugins: (defaultPlugins) => [...defaultPlugins],
-
-  // Load custom controls
-  controls: (defaultControls) => [...defaultControls],
-
-  // Read plugin pages for specific settings
-  settings: {},
-};
-```
-
 ## Plugins
@@ -157,0 +163,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1438233

increased by0.02%

Number of lines in readme file

174

increased by3.57%

No dependency changes