@team_yumi/ramen 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +26 -17
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -28,28 +28,37 @@ Para utilizarlo en un proyecto web:
28
28
  npm install @team_yumi/ramen-web
29
29
  ```
30
30
 
31
- ## 📚 Documentación
31
+ ## 📚 Como usar
32
32
 
33
- Puedes encontrar la documentación de Ramen UX en el siguiente link: [Ramen UX](https://ramen-ux-storybook-web.cencosudx.com/)
33
+ Para utilizar Ramen UX en tu proyecto, solo necesitas importar el archivo CSS en tu proyecto.
34
34
 
35
- ## 🤝 Contribuciones
35
+ Si es mobile:
36
36
 
37
- Si deseas contribuir con Ramen UX, puedes leer la guía de contribuciones en el siguiente link: [Contribuciones](https://github.com/Cencosud-xlabs/ramen-ux/blob/main/CONTRIBUTING.md)
37
+ ```tsx
38
+ import '@team_yumi/ramen/index.css';
39
+ ```
40
+
41
+ Si es web:
38
42
 
39
- ## 📝 Licencia
43
+ ```tsx
44
+ import '@team_yumi/ramen-web/index.css';
45
+ ```
40
46
 
41
- Ramen UX está licenciado bajo la licencia [MIT](./LICENSE).
47
+ Luego puedes utilizar los componentes de Ramen UX en tu proyecto.
42
48
 
43
- ## 📢 Roadmap
49
+ ```tsx
50
+ /* Si es Mobile, import: */
51
+ import { XButton } from '@team_yumi/ramen';
44
52
 
45
- ## 📢 ToDo
53
+ /* Si es Web, import: */
54
+ import { XButton } from '@team_yumi/ramen-web';
46
55
 
47
- - [ ] Licencia
48
- - [ ] Documentación
49
- - [ ] Storybook
50
- - [ ] Tests
51
- - [ ] CI/CD
52
- - [ ] Release
53
- - [ ] Contribuciones
54
- - [ ] Roadmap
55
- - [ ] Ejemplos
56
+ function App() {
57
+ return (
58
+ <XButton
59
+ onClick={() => console.log('Hello World')}
60
+ text="Cencosud X"
61
+ />
62
+ );
63
+ }
64
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@team_yumi/ramen",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "license": "MIT",
5
5
  "peerDependencies": {
6
6
  "react": ">=16.8.0"