@artilleryio/alpha-centauri-theme - npm Package Compare versions

Comparing version 0.1.7 to 0.1.8

package.json

 {
   "name": "@artilleryio/alpha-centauri-theme",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "TailwindCSS theme for Alpha Centauri design system built by the Artillery team.",
@@ -5,0 +5,0 @@ "main": "theme.js",

README.md

@@ -1,3 +0,45 @@
-# @alpha-centauri/theme
+# @artilleryio/alpha-centauri-theme
 
-Central Tailwind theme and design tokens to be shared between packages.
+Central Tailwind theme and design tokens to be shared between packages. This package shouldn't be updated without prior approval, 👮‍♂️ Consistency Police!
+
+## Installation
+Simply run the following...
+
+```
+npm install @artilleryio/alpha-centauri-theme
+```
+
+...and to upgrade:
+
+```
+npm install @artilleryio/alpha-centauri-theme@latest
+```
+
+## Usage
+For full documentation on our design tokens and theme, visit our [Visualiser](https://alpha-centauri.vercel.app/).
+
+Once you've installed the package, you will need to require it in your projects `tailwind.config.js`, like so:
+
+```
+let theme = require('@artilleryio/alpha-centauri-theme');
+
+module.exports = {
+  content: [
+    './src/**/*.{js,ts,jsx,tsx}',
+    './src/components/**/*.{js,ts,jsx,tsx}',
+  ],
+  darkMode: 'media',
+  theme,
+  plugins: [],
+};
+```
+
+## Contributing
+The project is currently bundled together using [Rollup](https://rollupjs.org/guide/en/). This makes it quite simple to build and publish changes. You will also need to be setup via NPM to be able to publish new versions of the package.
+
+Typically, once you've run `npm run lint-fix` from the project root, you can build and publish by:
+
+1. Bumping up the version number in `package.json`.
+2. You can then simply run `npm publish` and this pushes the latest version of the package to NPM.
+
+You will need to update the package wherever it is in use, in the wild (e.g. Control Panel etc.)

theme.js

@@ -65,4 +65,5 @@ module.exports = {
     fontSize: {
-      micro: '0.563rem',
-      xxxsm: '0.625rem',
+      xmicro: '0.563rem',
+      micro: '0.625rem',
+      xxxsm: '0.688rem',
       xxsm: '0.75rem',
@@ -69,0 +70,0 @@ xsm: '0.813rem',

No alert changes

Improved metrics

Total package byte prevSize

3297

increased by72.53%

Lines of code

85

increased by1.19%

Number of lines in readme file

46

increased by1433.33%

No dependency changes