From 38dd24ce7c4143c2c46ad3dd59426b9b266c1dcc Mon Sep 17 00:00:00 2001 From: wan Date: Wed, 10 Apr 2024 17:07:39 -0300 Subject: [PATCH 1/3] :memo: Update readme --- README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 52 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ec1b7a9..3660024 100644 --- a/README.md +++ b/README.md @@ -1 +1,52 @@ -# react-css +

+ logo +

@squidit/react-css

+

This repository contains a React component library developed to facilitate the creation of consistent and elegant interfaces, following a custom style guide. The included components are highly customizable and designed to be reusable across a variety of React projects.

+

+ +## Table of contents + +- [Installation](#installation) +- [How to Use](#how-to-use) +- [Customization](#customization) +- [License](#license) + + +## Installation + +To use this library in your React project, you can install it via npm or yarn: + +```bash +npm install @squidit/css @squidit/react-css +# or +yarn add @squidit/css @squidit/react-css +``` + +## How to Use + +After installation, you can import and use the components as needed in your React components: + +```jsx +import React from 'react'; +import { SqButton } from '@squidit/react-css'; + +const MyComponent = () => { + return ( +
+ Click Here +
+ ); +}; + +export default MyComponent; +``` + +## Customization + +This library allows high flexibility and customization of the components. You can modify the default styles of the components using specific props or by overriding the styles via CSS. + +## License + +This project is licensed under the [MIT License](LICENSE). \ No newline at end of file From 1c3b21a73f11194b23f31c04204a3d019493eaf5 Mon Sep 17 00:00:00 2001 From: wan Date: Wed, 10 Apr 2024 17:40:49 -0300 Subject: [PATCH 2/3] :rocket: Fix publish on npm --- .github/workflows/deploy-npm.yml | 8 ++++---- package-lock.json | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/deploy-npm.yml b/.github/workflows/deploy-npm.yml index 853ebd1..181e44d 100644 --- a/.github/workflows/deploy-npm.yml +++ b/.github/workflows/deploy-npm.yml @@ -12,13 +12,13 @@ jobs: - name: Setup Node uses: actions/setup-node@v3 with: - node-version: "18" - registry-url: "https://registry.npmjs.org" + node-version: '18' + registry-url: 'https://registry.npmjs.org' - name: Install dependencies and build 🔧 run: npm install && npm run build - name: Organize Files 📁 - run: cp -r dist src/dist && cp README.md src/dist/README.md && cp package.json src/dist/package.json + run: cp -r dist/src/* dist/ - name: Publish package on NPM 📦 - run: cd src/dist && npm publish --access public + run: npm publish --access public env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} diff --git a/package-lock.json b/package-lock.json index ed77ab6..d341d05 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@squidit/react-css", - "version": "0.0.4", + "version": "0.0.9", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@squidit/react-css", - "version": "0.0.4", + "version": "0.0.9", "license": "MIT", "devDependencies": { "@squidit/css": "latest", From 3c90e76759dd440f321425515443a5811f5c9f0a Mon Sep 17 00:00:00 2001 From: wan Date: Wed, 10 Apr 2024 17:41:10 -0300 Subject: [PATCH 3/3] :bookmark: Bump version --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 66e25ad..c59e483 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@squidit/react-css", - "version": "0.0.9", + "version": "0.0.10", "scripts": { "format": "prettier --write --parser typescript '**/*.{ts,tsx}'", "lint": "eslint src --ext js,ts,tsx",