Rename lib to Teaful

teafuljs · Nov 5, 2021 · 0a42c4f · 0a42c4f
1 parent c0f6ed5
commit 0a42c4f
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 54 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -54,7 +54,7 @@
     }
   ],
   "contributorsPerLine": 7,
-  "projectName": "fragstore",
+  "projectName": "teaful",
   "projectOwner": "aralroca",
   "repoType": "github",
   "repoHost": "https://github.com",

diff --git a/README.md b/README.md
@@ -1,17 +1,17 @@
- <img src="logo.svg" width="200" alt="Fragstore" align="right" />
+ <img src="logo.svg" width="200" alt="Teaful" align="right" />
 
 <h1>
-<div><b>Fragstore</b></div>
+<div><b>Teaful</b></div>
 </h1>
 
 _Tiny, easy and powerful **React state management** library_
 
-[![npm version](https://badge.fury.io/js/fragstore.svg)](https://badge.fury.io/js/fragstore)
-[![gzip size](https://img.badgesize.io/https://unpkg.com/fragstore?compression=gzip&label=gzip)](https://unpkg.com/fragstore)
-[![CI Status](https://github.com/aralroca/fragstore/actions/workflows/test.yml/badge.svg)](https://github.com/aralroca/fragstore/actions/workflows/test.yml)
-[![Maintenance Status](https://badgen.net/badge/maintenance/active/green)](https://github.com/aralroca/fragstore#maintenance-status)
-[![Weekly downloads](https://badgen.net/npm/dw/fragstore?color=blue)](https://www.npmjs.com/package/fragstore)
-[![GitHub Discussions: Chat With Us](https://badgen.net/badge/discussions/chat%20with%20us/purple)](https://github.com/aralroca/fragstore/discussions)
+[![npm version](https://badge.fury.io/js/teaful.svg)](https://badge.fury.io/js/teaful)
+[![gzip size](https://img.badgesize.io/https://unpkg.com/teaful?compression=gzip&label=gzip)](https://unpkg.com/teaful)
+[![CI Status](https://github.com/aralroca/teaful/actions/workflows/test.yml/badge.svg)](https://github.com/aralroca/teaful/actions/workflows/test.yml)
+[![Maintenance Status](https://badgen.net/badge/maintenance/active/green)](https://github.com/aralroca/teaful#maintenance-status)
+[![Weekly downloads](https://badgen.net/npm/dw/teaful?color=blue)](https://www.npmjs.com/package/teaful)
+[![GitHub Discussions: Chat With Us](https://badgen.net/badge/discussions/chat%20with%20us/purple)](https://github.com/aralroca/teaful/discussions)
 [![PRs Welcome][badge-prwelcome]][prwelcome]<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
@@ -54,9 +54,9 @@ _Tiny, easy and powerful **React state management** library_
 ## Installation 🧑🏻‍💻
 
 ```sh
-yarn add fragstore
+yarn add teaful
 # or
-npm install fragstore --save
+npm install teaful --save
 ```
 
 ## Init your store 👩🏽‍🎨
@@ -66,7 +66,7 @@ Each store has to be created with the `createStore` function. This function retu
 ### createStore
 
 ```js
-import createStore from "fragstore";
+import createStore from "teaful";
 
 const { useStore } = createStore();
 ```
@@ -148,7 +148,7 @@ import { useStore } from '../store'
 It's recommended to use the `useStore` hook as a proxy to indicate exactly what **portion of the store** you want. This way you only subscribe to this part of the store avoiding unnecessary re-renders.
 
 ```js
-import createStore from "fragstore";
+import createStore from "teaful";
 
 const { useStore } = createStore({
   username: "Aral",
@@ -483,7 +483,7 @@ You can have as many stores as you want. The only thing you have to do is to use
 store.js
 
 ```js
-import createStore from "fragstore";
+import createStore from "teaful";
 
 export const { useStore: useCart } = createStore({ price: 0, items: [] });
 export const { useStore: useCounter } = createStore({ count: 0 });
@@ -604,11 +604,11 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- markdownlint-disable -->
 <table>
   <tr>
-    <td align="center"><a href="https://aralroca.com"><img src="https://avatars3.githubusercontent.com/u/13313058?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Aral Roca Gomez</b></sub></a><br /><a href="#maintenance-aralroca" title="Maintenance">🚧</a> <a href="https://github.com/aralroca/fragstore/commits?author=aralroca" title="Code">💻</a></td>
+    <td align="center"><a href="https://aralroca.com"><img src="https://avatars3.githubusercontent.com/u/13313058?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Aral Roca Gomez</b></sub></a><br /><a href="#maintenance-aralroca" title="Maintenance">🚧</a> <a href="https://github.com/aralroca/teaful/commits?author=aralroca" title="Code">💻</a></td>
     <td align="center"><a href="https://twitter.com/danielofair"><img src="https://avatars.githubusercontent.com/u/4655428?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Danielo Artola</b></sub></a><br /><a href="#infra-danielart" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
     <td align="center"><a href="https://shinshin86.com"><img src="https://avatars.githubusercontent.com/u/8216064?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Yuki Shindo</b></sub></a><br /><a href="#infra-shinshin86" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
-    <td align="center"><a href="https://github.com/dididy"><img src="https://avatars.githubusercontent.com/u/16266103?v=4?s=100" width="100px;" alt=""/><br /><sub><b>YONGJAE LEE(이용재)</b></sub></a><br /><a href="https://github.com/aralroca/fragstore/issues?q=author%3Adididy" title="Bug reports">🐛</a></td>
-    <td align="center"><a href="https://juejin.cn/user/4318537404123688/posts"><img src="https://avatars.githubusercontent.com/u/16329407?v=4?s=100" width="100px;" alt=""/><br /><sub><b>niexq</b></sub></a><br /><a href="https://github.com/aralroca/fragstore/commits?author=niexq" title="Documentation">📖</a> <a href="#infra-niexq" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
+    <td align="center"><a href="https://github.com/dididy"><img src="https://avatars.githubusercontent.com/u/16266103?v=4?s=100" width="100px;" alt=""/><br /><sub><b>YONGJAE LEE(이용재)</b></sub></a><br /><a href="https://github.com/aralroca/teaful/issues?q=author%3Adididy" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://juejin.cn/user/4318537404123688/posts"><img src="https://avatars.githubusercontent.com/u/16329407?v=4?s=100" width="100px;" alt=""/><br /><sub><b>niexq</b></sub></a><br /><a href="https://github.com/aralroca/teaful/commits?author=niexq" title="Documentation">📖</a> <a href="#infra-niexq" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
   </tr>
 </table>
 

diff --git a/logo.svg b/logo.svg
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "fragstore",
+  "name": "teaful",
   "version": "0.7.0",
   "description": "Tiny, easy and powerful React state management (less than 1kb)",
   "license": "MIT",
@@ -21,7 +21,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/aralroca/fragstore.git"
+    "url": "https://github.com/aralroca/teaful.git"
   },
   "source": "package/index.js",
   "main": "dist/index.js",
@@ -91,5 +91,5 @@
   "mangle": {
     "regex": "^_"
   },
-  "bugs": "https://github.com/aralroca/fragstore/issues"
-}
+  "bugs": "https://github.com/aralroca/teaful/issues"
+}