Skip to content

Commit 3aefbac

Browse files
authored
Merge pull request #22 from rootstrap/docs/cli_use_root_readme_as_cli_readme
docs(cli): use root Readme as CLI Readme
2 parents a099edc + b96d1bb commit 3aefbac

File tree

5 files changed

+88
-164
lines changed

5 files changed

+88
-164
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,6 @@ yarn-error.log
2929

3030
expo-env.d.ts
3131
# @end expo-cli
32+
33+
# cli
34+
cli/README.md

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
<p align="center">
2-
<img alt="React Native Template Obytes" src="https://github.com/obytes/react-native-template-obytes/assets/11137944/a8163d23-897a-4efe-91ce-b9bf7348c18f" width="200" />
2+
<img alt="Rootstrap's React Native Template" src="https://github.com/obytes/react-native-template-obytes/assets/11137944/a8163d23-897a-4efe-91ce-b9bf7348c18f" width="200" />
33
</p>
44

55
<h1 align="center">
6-
React Native Template Obytes
6+
Rootstrap's React Native Template
77
</h1>
88

9-
![expo](https://img.shields.io/github/package-json/dependency-version/obytes/react-native-template-obytes/expo?label=expo) ![react-native](https://img.shields.io/github/package-json/dependency-version/obytes/react-native-template-obytes/react-native?label=react-native) ![GitHub Repo stars](https://img.shields.io/github/stars/obytes/react-native-template-obytes) ![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/m/obytes/react-native-template-obytes) ![GitHub issues](https://img.shields.io/github/issues/obytes/react-native-template-obytes) ![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/obytes/react-native-template-obytes)
9+
![expo](https://img.shields.io/github/package-json/dependency-version/rootstrap/react-native-template/expo?label=expo) ![react-native](https://img.shields.io/github/package-json/dependency-version/rootstrap/react-native-template/react-native?label=react-native) ![GitHub Repo stars](https://img.shields.io/github/stars/rootstrap/react-native-template) ![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/m/rootstrap/react-native-template) ![GitHub issues](https://img.shields.io/github/issues/rootstrap/react-native-template) ![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/rootstrap/react-native-template)
1010

1111
📱 A template for your next React Native project 🚀, Made with developer experience and performance first: Expo, TypeScript, TailwindCSS, Husky, Lint-Staged, expo-router, react-query, react-hook-form, I18n.
1212

13+
Based on [Obytes Starter](https://github.com/obytes/react-native-template-obytes).
14+
1315
# Overview
1416

1517
As a team of experienced developers at Obytes Mobile Tribe, we have spent years refining our approach to building high-quality React Native applications. Our starter kit is based on the best practices and tools that we have found to be most effective in our projects.
@@ -37,16 +39,16 @@ When creating this starter kit, we had several guiding principles in mind::
3739

3840
## ⭐ Key Features
3941

40-
- ✅ The latest version of Expo SDK, Along with the Custom Dev client, you can leverage the best of the Expo ecosystem and maintain full control over your app.
42+
- ✅ The latest version of Expo SDK, along with the Custom Dev client: you can leverage the best of the Expo ecosystem and maintain full control over your app.
4143
- 🎉 [TypeScript](https://www.typescriptlang.org/) for type checking, to help you catch bugs and improve code quality.
42-
- 💅 A minimal UI kit built with [TailwindCSS](https://www.nativewind.dev/), With the most common components you should have in your app.
43-
- ⚙️ Support for multiple environments builds, including Production, Staging, and Development, using Expo configuration.
44+
- 💅 A minimal UI kit built with [NativeWind](https://www.nativewind.dev/), which provides a range of pre-defined classes for styling your app.
45+
- ⚙️ Support for multiple environment builds, including Production, Staging, and Development, using Expo configuration.
4446
- 🦊 Husky for Git Hooks, to automate your git hooks and enforce code standards.
4547
- 💡 A clean project structure with Absolute Imports, to make it easier to navigate and manage your code.
46-
- 🚫 Lint-staged for running Eslint and TypeScript checks on Git staged files, to ensure that your code is always up to standards.
48+
- 🚫 Lint-staged for running ESLint and TypeScript checks on Git staged files, to ensure that your code is always up to standards.
4749
- 🗂 VSCode recommended extensions, settings, and snippets to enhance the developer experience.
4850
- ☂️ Pre-installed [Expo Router](https://docs.expo.dev/router/introduction/) with examples, to provide a comprehensive navigation solution for your app.
49-
- 💫 An auth flow with [Zustand](https://github.com/pmndrs/zustand) and [react-native-mmkv](https://github.com/mrousavy/react-native-mmkv) as a storage solution to save sensitive data.
51+
- 💫 An auth flow with [zustand](https://github.com/pmndrs/zustand) and [react-native-mmkv](https://github.com/mrousavy/react-native-mmkv) as a storage solution to save sensitive data.
5052
- 🛠 +10 workflows for building, releasing, testing and distributing your app using [Github action](https://github.com/features/actions).
5153
- 🔥 [React Query](https://react-query.tanstack.com/) and [axios](https://github.com/axios/axios) for fetching data, to help you build efficient and performant apps.
5254
- 🧵 A good approach for handling forms with [react-hook-form](https://react-hook-form.com/) and [zod](https://github.com/colinhacks/zod) for validation + keyboard handling.
@@ -55,15 +57,15 @@ When creating this starter kit, we had several guiding principles in mind::
5557

5658
## ✍️ Documentation
5759

58-
- [Create new project ](https://starter.obytes.com/getting-started/create-new-app/)
59-
- [Rules and Conventions](https://starter.obytes.com/getting-started/rules-and-conventions/)
60-
- [Project structure](https://starter.obytes.com/getting-started/project-structure)
61-
- [Environment vars and config](https://starter.obytes.com/getting-started/environment-vars-config)
62-
- [UI and Theming](https://starter.obytes.com/ui-and-theme/ui-theming)
63-
- [Components](https://starter.obytes.com/ui-and-theme/components)
64-
- [Forms](https://starter.obytes.com/ui-and-theme/forms/)
65-
- [Data fetching](https://starter.obytes.com/guides/data-fetching/)
66-
- [Contribute to starter](https://starter.obytes.com/how-to-contribute/)
60+
- [Create new project ](https://rootstrap.github.io/react-native-template/getting-started/create-new-app/)
61+
- [Rules and Conventions](https://rootstrap.github.io/react-native-template/getting-started/rules-and-conventions/)
62+
- [Project structure](https://rootstrap.github.io/react-native-template/getting-started/project-structure/)
63+
- [Environment vars and config](https://rootstrap.github.io/react-native-template/getting-started/environment-vars-config/)
64+
- [UI and Theming](https://rootstrap.github.io/react-native-template/ui-and-theme/ui-theming/)
65+
- [Components](https://rootstrap.github.io/react-native-template/ui-and-theme/components/)
66+
- [Forms](https://rootstrap.github.io/react-native-template/ui-and-theme/forms/)
67+
- [Data fetching](https://rootstrap.github.io/react-native-template/guides/data-fetching/)
68+
- [Contribute to starter](https://rootstrap.github.io/react-native-template/how-to-contribute/)
6769

6870
## 😉 Why Expo?
6971

@@ -108,7 +110,7 @@ We value the feedback and contributions of our users, and we encourage you to le
108110
- [React Native Gesture Handler](https://docs.swmansion.com/react-native-gesture-handler/docs/)
109111
- [React Native Reanimated](https://docs.swmansion.com/react-native-reanimated/docs/)
110112
- [React Native Svg](https://github.com/software-mansion/react-native-svg)
111-
- [ React Error Boundaries](https://github.com/bvaughn/react-error-boundary)
113+
- [React Error Boundaries](https://github.com/bvaughn/react-error-boundary)
112114
- [Expo Image](https://docs.expo.dev/versions/unversioned/sdk/image/)
113115

114116
## Contributors

cli/README.md

Lines changed: 0 additions & 143 deletions
This file was deleted.

0 commit comments

Comments
 (0)