Skip to content

Commit

Permalink
readme npm and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelvermeuln committed Sep 6, 2023
1 parent bb52ae8 commit f4ab0e3
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 8 deletions.
3 changes: 1 addition & 2 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ jobs:
- run:
name: Authenticate with registry
command: echo "//registry.npmjs.org/:_authToken=$npm_TOKEN" > .npmrc
- run: npm publish --force
- run: npm publish

publish-docs:
<<: *defaults
Expand All @@ -64,7 +64,6 @@ jobs:
- run: npm install
- run: npx chromatic --auto-accept-changes --project-token=$PROJECT_CHROMATIC_TOKEN


workflows:
version: 2
build-and-publish:
Expand Down
50 changes: 49 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,49 @@
# tsp para fazer o transforme do ts para js, ele e mais rapido pq usa vite por de baixo dos panos
<p align="center">
<h3 align="center">chardonnay</h3>

<p align="center">
A mobile first frontend framework made with ( evino ).
</p>

<br>

<p align="center">It is still in early development</p>

<br/>
<p align="center">This project will use tsp to convert all TypeScript code</p>

## Examples

We have all components listed on our documentation. Here is the first one to get you started:

```tsx
import React from "react";
import { Button } from "chardonnay";

function App() {
return <Button>Hello World</Button>;
}

export { App };

```

## Installation

```bash
npm install chardonnay
```

But all commands run with `yarn` as well.

## Testing

All tests are done using `Vitest`

```bash
npm test
```

## License

Licensed under [MIT](LICENSE). Enjoy.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "chardonnay",
"version": "1.0.2",
"version": "1.0.3",
"description": "A mobile first frontend framework made with wine",
"main": "./dist/index.js",
"module": "./dist/index.mjs",
Expand Down
13 changes: 12 additions & 1 deletion src/docs/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,15 @@ import { Meta } from '@storybook/blocks';

# Vissimo

designer system evino
## Designer system evino

[![N|Solid]( https://res.cloudinary.com/evino/image/upload/w_330,h_110/v1/web/assets/logo/logo-red.svg)](https://www.evino.com.br/)

Here are all the components documentation.
For you to enjoy and use all the flexibility of our design.

## Deploy

- branch from main
- To publish in npm need to change the version in the package
- Project uses typescript
7 changes: 4 additions & 3 deletions src/index.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import * as Tokens from './tokens'
import * as Components from './components'
import { Colors, BorderRadius, Spacing } from './tokens'
import { Button } from './components'

export { Components, Tokens }
// export components, token publish npm
export { Button, Colors, BorderRadius, Spacing }

0 comments on commit f4ab0e3

Please sign in to comment.