@sikka/hawa 0.1.7 → 0.1.8-beta

package/README.md

@@ -1,60 +1,38 @@
-<p align="center">
-  <img src="https://xakher-images.s3.ap-southeast-1.amazonaws.com/hawa-logo.png" alt="Hawa | هواء" />
-</p>
+This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
 
-# Hawa | هواء
+## Getting Started
 
-[![NPM](https://img.shields.io/npm/v/@sikka/hawa.svg?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/@sikka/hawa)
-[![NPM](https://img.shields.io/npm/dt/@sikka/hawa.svg?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/@sikka/hawa)
-
-> Opinionated UI Kit for web apps and websites built with TailwindCSS
-
-## Install
+First, run the development server:
 
 ```bash
-npm install --save @sikka/hawa
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
 ```
 
-# Roadmap
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
 
-- Organize code
+You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
 
-</br>
+[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
 
-# Contributing
+The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
 
-To contribute, clone this github repository and run the development server
+This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
 
-```bash
-git clone git@github.com:sikka-software/hawa.git
-cd hawa
-npm install
-```
+## Learn More
 
-</br>
+To learn more about Next.js, take a look at the following resources:
 
-# TESTING
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
 
-Run development server
-
-```bash
-git clone git@github.com:sikka-software/hawa.git
-cd hawa
-npm install
-npm run storybook
-```
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
 
-## License
+## Deploy on Vercel
 
-MIT © [SIKKA SOFTWARE](https://sikka.sa)
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
 
-<!--start: logo-->
-<p align="center">
-  <a href="https://sikka.io">
-    <img width="44" alt="Sikka" src="https://i.postimg.cc/8cK4tnKQ/sikka-symbol-black.png">
-  </a>
-</p>
-<p align="center">
-  <sub>An open source project by <a href="https://sikka.io">Sikka</a></sub>
-</p>
-<!--end: logo-->
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.