Skip to content

Commit 4eff358

Browse files
zy035017duanshao1@h-partners.com
zy035017
and
duanshao1@h-partners.com
authored
feat:[issues:#20]修改README.md文件 (#22)
Co-authored-by: duanshao1@h-partners.com <duanshao1@h-partners.com>
1 parent 23d35d9 commit 4eff358

File tree

1 file changed

+7
-190
lines changed

1 file changed

+7
-190
lines changed

‎README.md

Lines changed: 7 additions & 190 deletions
Original file line numberDiff line numberDiff line change
@@ -1,196 +1,13 @@
1-
# <img src="https://raw.githubusercontent.com/GeekyAnts/NativeBase/master/img/header_new.png" alt="Nativebase Logo">
1+
# @react-native-oh-tpl/native-base
22

3-
[![Financial Contributors on Open Collective](https://opencollective.com/NativeBase/all/badge.svg?label=financial+contributors)](https://opencollective.com/NativeBase)
4-
[![](https://img.shields.io/discord/785491682719301643?label=Discord&logo=discord&logoColor=%237289DA)](https://discord.com/invite/TSgCw2UPmb)
5-
[![npm next package](https://img.shields.io/npm/v/native-base/next.svg)](https://www.npmjs.com/package/native-base)
6-
[![npm latest package](https://img.shields.io/npm/v/native-base/latest.svg)](https://www.npmjs.com/package/native-base)
7-
[![npm downloads](https://img.shields.io/npm/dm/native-base.svg)](https://npm-stat.com/charts.html?package=native-base)
8-
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/GeekyAnts/NativeBase/blob/master/LICENSE)
9-
[![Follow on Twitter](https://img.shields.io/twitter/follow/nativebase.svg?label=follow+NativeBase)](https://twitter.com/nativebase)
10-
[![Github Stars](https://img.shields.io/github/stars/GeekyAnts/NativeBase)](https://img.shields.io/github/stars/GeekyAnts/NativeBase)
3+
This project is based on [NativeBase](https://github.com/GeekyAnts/NativeBase)
114

12-
**IMPORTANT MESSAGE** — If you are starting a new project with NativeBase, we recommend using [gluestack-ui](https://ui.gluestack.io/) instead. [Know More](https://nativebase.io/blogs/road-ahead-with-gluestack-ui).
5+
## Documentation
136

14-
## NativeBase is a mobile-first, accessible component library for building a consistent design system across android, iOS & web.
7+
- [中文](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-cn/NativeBase.md)
158

16-
[**Website**](https://nativebase.io/)
17-
<br/>
18-
[**Documentation**](https://docs.nativebase.io/)
9+
- [English](https://gitee.com/react-native-oh-library/usage-docs/blob/master/en/NativeBase.md)
1910

20-
## Table of Contents
11+
## License
2112

22-
1. [Introduction](#1-introduction)
23-
2. [Motivation](#2-motivation)
24-
3. [Features](#3-features)
25-
4. [Dependencies](#4-dependencies)
26-
5. [Installation & Setup](#5-installation)
27-
6. [Components](#6-components)
28-
7. [Examples](#7-examples)
29-
8. [KitchenSink App](#8-kitchensink-app)
30-
9. [Tech Stack](#9-tech-stack)
31-
10. [Compatible Versions](#10-compatible-versions)
32-
11. [Contributors](#11-contributors)
33-
12. [Changelog](#12-changelog)
34-
13. [Community](#13-community)
35-
14. [License](#14-license)
36-
37-
## 1. Introduction?
38-
39-
[NativeBase](https://nativebase.io/) is a mobile-first, component library for React & React Native. Version 3.0 ships with complete ARIA integration, support for utility props and nearly 40 components that are consistent across Android, iOS and Web. Fast-track your dev process with NativeBase 3.0.
40-
41-
**Recommended by [Awesome React Native](https://github.com/jondot/awesome-react-native)**
42-
43-
> NativeBase was added to the list of Frameworks of Awesome React Native and it is used by numerous React lovers across the world.
44-
45-
## 2. Motivation
46-
47-
Building with React Native from scratch is a tedious process with multiple steps such as adding styling, interactions, state management, responsiveness, accessibility, etc. We wanted to build and ship accessible, high-quality apps quickly.
48-
<br />
49-
50-
Our inspirations include Material UI, Chakra UI, Ant Design, Braid Design System, Bootstrap, TailwindCSS & Flutter.
51-
52-
## 3. Features
53-
54-
### **Out of the Box Accessibility**
55-
56-
Integrated with React ARIA and React Native ARIA, which provides React hooks. This enables you to build accessible design systems in no time.
57-
58-
<img src="https://raw.githubusercontent.com/GeekyAnts/NativeBase/development/img/feature.png" alt="Out of the box accessibility">
59-
60-
### **Supporting Utility Props**
61-
62-
Powered by [Styled System](https://styled-system.com) so you can rapidly build custom UI components with constraint-based utility style props.
63-
64-
### **Rich Component Library**
65-
66-
NativeBase offers around 40 components so you can build seamlessly. It includes button, checkbox, flex, stack and more.
67-
68-
### **Highly Themeable**
69-
70-
Themeability is one of the core elements of NativeBase. You can customise your app theme and component styles to your heart's content.
71-
72-
<img src="https://raw.githubusercontent.com/GeekyAnts/NativeBase/development/img/theme.png" alt="Nativebase Logo">
73-
74-
### **Available for Both Mobile and Web**
75-
76-
NativeBase 3.0 is powered by React Native Web so you can build consistent UIs across Web, Android and iOS.
77-
78-
### **Responsiveness Made Easy**
79-
80-
Instead of manually adding responsiveness, NativeBase 3.0 allows you to provide object and array values to add responsive styles.
81-
82-
### **Now with** **Dark Mode**
83-
84-
Building apps with a dark mode setting just got a whole lot easier. NativeBase is now optimised for light and dark modes.
85-
86-
## 4. Dependencies
87-
88-
React Native, Expo
89-
90-
## 5. Installation
91-
92-
NativeBase is supported in Expo or React Native CLI initiated apps. Web support is made possible by react-native-web.
93-
94-
Refer the [guides](https://docs.nativebase.io/installation) to setup NativeBase in your React app.
95-
96-
## 6. Components
97-
98-
NativeBase 3.0 is a rich component library with nearly 40 components.
99-
100-
- [**Layout**](https://docs.nativebase.io/box)
101-
- [**Forms**](https://docs.nativebase.io/button)
102-
- [**Data Display**](https://docs.nativebase.io/badge)
103-
- [**Feedback**](https://docs.nativebase.io/alert)
104-
- [**Typography**](https://docs.nativebase.io/text)
105-
- [**Overlay** ](https://docs.nativebase.io/alert-dialog)
106-
- [**Disclosure**](https://docs.nativebase.io/action-sheet)
107-
- [**Media & Icons**](https://docs.nativebase.io/avatar)
108-
- [**Transition**](https://docs.nativebase.io/presence-transition)
109-
- [**Other**](https://docs.nativebase.io/fab)
110-
111-
## 7. Examples
112-
113-
[Check out the Todo-List example](https://docs.nativebase.io/todo-list)
114-
115-
## 8. KitchenSink App
116-
117-
[Kitchen Sink](https://kitchensink.nativebase.io/) is a comprehensive demo app showcasing all the NativeBase components in action. It includes buttons, forms, icons, etc.
118-
119-
<div class="flexible">
120-
<img src="https://github.com/GeekyAnts/NativeBase/raw/development/img/kitchensink.gif" height="500px" alt="Kitchensink App gif">
121-
<img src="https://raw.githubusercontent.com/GeekyAnts/NativeBase/development/img/qr.png" height="500px" alt="Kitchensink App QR code">
122-
</div>
123-
124-
## 9. Tech Stack
125-
126-
JavaScript, React Native, Styled System
127-
128-
### Made with :heart: at [GeekyAnts](https://geekyants.com/?utm_source=nb-github&utm_medium=landing+page&utm_campaign=nativebase-github-cta)
129-
130-
NativeBase is an open-source project made by the tech-savvy geeks at GeekyAnts.
131-
GeekyAnts is a group of React Native experts. Do [get in touch with us](https://geekyants.com/hire/?utm_source=nb-github&utm_medium=landing+page&utm_campaign=nativebase-github-hire-cta) for any help with your React Native project. Always happy to help!
132-
133-
## 10. Compatible Versions
134-
135-
| NativeBase | React Native |
136-
| -------------------------------- | ---------------------------------------------------------- |
137-
| v0.1.1 | v0.22 to v0.23 |
138-
| v0.2.0 to v0.3.1 | v0.24 to v0.25 |
139-
| v0.4.6 to v0.4.9 | v0.26.0 - v0.27.1 |
140-
| v0.5.0 to v0.5.15 | v0.26.0 - v0.37.0 |
141-
| v0.5.16 to v0.5.20 | v0.38.0 - v0.39.0 |
142-
| v2.0.0-alpha1 to v2.1.3 | v0.38.0 to v0.43.0 |
143-
| v2.1.4 to v2.1.5 | v0.44.0 to v0.45.0 |
144-
| v2.2.0 | v0.44.0 to v0.45.0 |
145-
| v2.2.1 | v0.46.0 and above |
146-
| v2.3.0 to 2.6.1 | v0.46.0 and above (does not support React 16.0.0-alpha.13) |
147-
| v2.7.0 | v0.56.0 and above |
148-
| v3.0.0-next.36 to v3.0.0-next-41 | v0.63.0 and above |
149-
| v3.0.0 to latest | v0.63.0 and above |
150-
151-
## 11. Contributors
152-
153-
### Code Contributors
154-
155-
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
156-
<a href="https://github.com/GeekyAnts/NativeBase/graphs/contributors"><img src="https://opencollective.com/NativeBase/contributors.svg?width=890&button=false" /></a>
157-
158-
### Financial Contributors
159-
160-
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/NativeBase/contribute)]
161-
162-
#### Individuals
163-
164-
<a href="https://opencollective.com/NativeBase"><img src="https://opencollective.com/NativeBase/individuals.svg?width=890"></a>
165-
166-
#### Organizations
167-
168-
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/NativeBase/contribute)]
169-
170-
<a href="https://opencollective.com/NativeBase/organization/0/website"><img src="https://opencollective.com/NativeBase/organization/0/avatar.svg"></a>
171-
<a href="https://opencollective.com/NativeBase/organization/1/website"><img src="https://opencollective.com/NativeBase/organization/1/avatar.svg"></a>
172-
<a href="https://opencollective.com/NativeBase/organization/2/website"><img src="https://opencollective.com/NativeBase/organization/2/avatar.svg"></a>
173-
<a href="https://opencollective.com/NativeBase/organization/3/website"><img src="https://opencollective.com/NativeBase/organization/3/avatar.svg"></a>
174-
<a href="https://opencollective.com/NativeBase/organization/4/website"><img src="https://opencollective.com/NativeBase/organization/4/avatar.svg"></a>
175-
<a href="https://opencollective.com/NativeBase/organization/5/website"><img src="https://opencollective.com/NativeBase/organization/5/avatar.svg"></a>
176-
<a href="https://opencollective.com/NativeBase/organization/6/website"><img src="https://opencollective.com/NativeBase/organization/6/avatar.svg"></a>
177-
<a href="https://opencollective.com/NativeBase/organization/7/website"><img src="https://opencollective.com/NativeBase/organization/7/avatar.svg"></a>
178-
<a href="https://opencollective.com/NativeBase/organization/8/website"><img src="https://opencollective.com/NativeBase/organization/8/avatar.svg"></a>
179-
<a href="https://opencollective.com/NativeBase/organization/9/website"><img src="https://opencollective.com/NativeBase/organization/9/avatar.svg"></a>
180-
181-
## 12. Changelog
182-
183-
[Check out the changelog in the official documentation](https://docs.nativebase.io/changelog)
184-
185-
## 13. Community
186-
187-
- [Facebook](https://www.facebook.com/nativebaseio)
188-
- [Twitter](https://twitter.com/nativebase)
189-
- [Discord](https://discord.com/invite/TSgCw2UPmb)
190-
- [Stackoverflow](https://stackoverflow.com/questions/tagged/native-base)
191-
- [Blog](https://nativebase.io/blogs)
192-
- [YouTube](https://www.youtube.com/channel/UCoL_iTwpY07vDs91974z3xA/about)
193-
194-
## 14. License
195-
196-
Licensed under the MIT License, Copyright © 2021 GeekyAnts. See [LICENSE](https://github.com/GeekyAnts/NativeBase/blob/master/LICENSE) for more information.
13+
This project is licensed under [The MIT License (MIT)](https://github.com/GeekyAnts/NativeBase/blob/master/LICENSE)

0 commit comments

Comments
 (0)