@web-fuse/wf-components 1.0.0 → 1.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@web-fuse/wf-components",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A library containing common form and display components",
   "type": "module",
   "main": "dist/index.cjs.js",

package/readme.md

@@ -0,0 +1,22 @@
+# Web-Fuse Components
+
+A library containing common form and display components. The component requires that you use the React Framework and relies on styled-components and antd packages. If you want to use the CodeBlock you will also need to install *react-copy-to-clipboard* and *react-syntax-highlighter*.
+
+## Previewing components
+
+You can preview and test the components by cloning the repository to your system and running storybook.
+
+1. Clone this repository to your system
+2. Open the directory in a terminal
+3. Install all dependencies by running `npm install` in the terminal
+4. To start storybook run `npm run storybook`
+
+## Local development
+
+To make changes in the repository you should first run storybook as explained in [Previewing Components](#previewing-components). Open the component you want to edit in storybook and navigate to the corresponding file in the `src` directory. Each component will have its own file or files. Stories are located in the `src/stories` directory.
+
+Each component must always be exported using `export default` and each component must always be assigned to a `const` variable before it is exported. If this is not done vite may have problems rebuilding the component and React will not know the name of the component.
+
+## Custom theme algorithm for antd
+
+If you are using the `theme.darkAlgorithm` in your antd `ConfigProvider` you may notice that your primary color is not preserved. Therefor this package includes the `wfDarkAlgorithm` export. The only change, compared the the darkAlgorithm exported by antd, is that it takes retains your primary color.