rename project

README.md

@@ -1,28 +1,38 @@
-# Tinnef SCSS Starter Kit
+# Barker
 
-This is an SCSS starter kit for the design system setup described in this
-article series: https://www.mathiaspolligkeit.com/tags/design-systems/.
+Barker is an SCSS starter kit for design systems.
 
 It includes:
 
-- project layout as described in the articles
-- themes, components, layouts and base styles
-- style dictionary
-- mixins and functions
-- webpack
-- dart-sass
-- stylelint
-- postcss
-- style guide generation
+- A [Style Dictionary](https://v4.styledictionary.com/) configuration for defining design tokens.
+- A sensible project layout and organized SCSS files for themes, components, layouts, and base styles.
+- SCSS mixins and functions for accessing design tokens.
+- A [Webpack](https://webpack.js.org/) configuration with [Esbuild](https://esbuild.github.io/), [dart-sass](https://sass-lang.com/dart-sass/) and [PostCSS](https://postcss.org/).
+- A [Stylelint](https://stylelint.io/) configuration.
 
-It doesn't have all the features I'd like it to have yet, but you can certainly
-use it to get started with a project. Just clone the repository.
+## Usage
+
+This kit cannot be installed and does not include any generators. Instead, clone
+the repository into your project and adapt it to your needs.
+
+```bash
+git clone [email protected]:woylie/barker.git
+cd barker
+rm -rf .github .git
+```
 
 ## Commands
 
-- dev build (tokens + : `yarn build`
-- build style dictionary tokens: `yarn build-tokens`
-- watch mode (does not watch style dictionary tokens): `yarn watch`
-- stylelint: `yarn stylelint`
-- fix stylelint errors: `yarn stylelint --fix`
-- format with prettier: `yarn prettier . --write`
+| Description                                         | Command                   |
+| --------------------------------------------------- | ------------------------- |
+| Development build (tokens, CSS, JS, etc.)           | `yarn build`              |
+| Build Style Dictionary tokens                       | `yarn build-tokens`       |
+| Watch mode (does not watch Style Dictionary tokens) | `yarn watch`              |
+| Stylelint                                           | `yarn stylelint`          |
+| Fix Stylelint issues                                | `yarn stylelint --fix`    |
+| Format with Prettier                                | `yarn prettier . --write` |
+
+## Resources
+
+Barker is based on ideas described in the
+[Design Systems article series](https://www.mathiaspolligkeit.com/tags/design-systems/).

package.json

@@ -1,8 +1,8 @@
 {
-  "name": "tinnef-starter",
+  "name": "barker",
   "version": "0.1.0",
   "description": "Starter kit for an SCSS-based design system",
-  "repository": "https://github.com/woylie/tinnef-scss-starter-kit",
+  "repository": "https://github.com/woylie/barker",
   "author": "Mathias Polligkeit",
   "license": "MIT",
   "type": "module",

yarn.lock

@@ -1033,6 +1033,32 @@ __metadata:
   languageName: node
   linkType: hard
 
+"barker@workspace:.":
+  version: 0.0.0-use.local
+  resolution: "barker@workspace:."
+  dependencies:
+    autoprefixer: "npm:^10.4.19"
+    css-loader: "npm:^7.1.2"
+    esbuild-loader: "npm:^4.2.0"
+    mini-css-extract-plugin: "npm:^2.9.0"
+    postcss: "npm:^8.4.39"
+    postcss-loader: "npm:^8.1.1"
+    postcss-scss: "npm:^4.0.9"
+    prettier: "npm:^3.3.2"
+    sass: "npm:^1.77.6"
+    sass-loader: "npm:^14.2.1"
+    style-dictionary: "npm:^4.0.0"
+    stylelint: "npm:^16.6.1"
+    stylelint-config-recess-order: "npm:^5.0.1"
+    stylelint-config-standard-scss: "npm:^13.1.0"
+    stylelint-declaration-strict-value: "npm:^1.10.4"
+    stylelint-order: "npm:^6.0.4"
+    stylelint-webpack-plugin: "npm:^5.0.1"
+    webpack: "npm:^5.92.1"
+    webpack-cli: "npm:^5.1.4"
+  languageName: unknown
+  linkType: soft
+
 "base64-js@npm:^1.3.1":
   version: 1.5.1
   resolution: "base64-js@npm:1.5.1"
@@ -4314,32 +4340,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"tinnef-starter@workspace:.":
-  version: 0.0.0-use.local
-  resolution: "tinnef-starter@workspace:."
-  dependencies:
-    autoprefixer: "npm:^10.4.19"
-    css-loader: "npm:^7.1.2"
-    esbuild-loader: "npm:^4.2.0"
-    mini-css-extract-plugin: "npm:^2.9.0"
-    postcss: "npm:^8.4.39"
-    postcss-loader: "npm:^8.1.1"
-    postcss-scss: "npm:^4.0.9"
-    prettier: "npm:^3.3.2"
-    sass: "npm:^1.77.6"
-    sass-loader: "npm:^14.2.1"
-    style-dictionary: "npm:^4.0.0"
-    stylelint: "npm:^16.6.1"
-    stylelint-config-recess-order: "npm:^5.0.1"
-    stylelint-config-standard-scss: "npm:^13.1.0"
-    stylelint-declaration-strict-value: "npm:^1.10.4"
-    stylelint-order: "npm:^6.0.4"
-    stylelint-webpack-plugin: "npm:^5.0.1"
-    webpack: "npm:^5.92.1"
-    webpack-cli: "npm:^5.1.4"
-  languageName: unknown
-  linkType: soft
-
 "tinycolor2@npm:^1.6.0":
   version: 1.6.0
   resolution: "tinycolor2@npm:1.6.0"