From cbe99e2b0ffb93f0db11dc4f203ed8f4fdbd527f Mon Sep 17 00:00:00 2001 From: Emin Khateeb Date: Mon, 17 Jun 2019 11:17:40 +0200 Subject: [PATCH] refactored readme --- README.md | 61 +++++++++++++++++++++---------------------------------- 1 file changed, 23 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 355d660..e7271d2 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,38 @@ -# :space_invader: React Native Template TypeScript ยท [![Build Status](https://travis-ci.org/emin93/react-native-template-typescript.svg?branch=master)](https://travis-ci.org/emin93/react-native-template-typescript) +# :space_invader: React Native Template TypeScript -Clean and minimalist React Native template for a quick start with TypeScript. +

+ + Build Status + + + Documentation + + + Maintenance + + + License: MIT + +

-[![Header](https://cdn-images-1.medium.com/max/500/1*E9RnPOATuhjuNrlFkv5oSg.jpeg)](https://medium.com/@emin93/react-native-typescript-b965059109d3) +> Clean and minimalist React Native template for a quick start with TypeScript. ## :star: Features -- Seamlessly integrated into the React Native CLI! :sparkles: +- Elegant usage directly within the [React Native CLI](https://github.com/react-native-community/cli) - Consistent with the default React Native template -- Always latest dependencies :raised_hands: +- Minimal additional dependencies -## :arrow_forward: Quick Start +## :arrow_forward: Usage -```bash +```sh react-native init MyApp --template typescript ``` -## :question: FAQ - -### What additional dependencies are included in this template? - -- [TypeScript](https://github.com/Microsoft/TypeScript) -- [Type definitions for React & React Native](https://github.com/DefinitelyTyped/DefinitelyTyped) - -This template always uses the latest versions of the dependencies at the time when the `react-native init` command is being executed. This means you don't have to worry about old versions. - -Lots of :heart: and credits to the owners and maintainers of those packages. - -### Does debugging work? - -Yes it does. :tada: - -[![Demonstration of working breakpoints in Visual Studio Code](https://cdn-images-1.medium.com/max/1600/1*ZXfzgq1xKz1B3chYy9xE7w.png)](https://medium.com/@emin93/react-native-typescript-b965059109d3) - -### How to do type checking? - -`npx tsc` - -## :globe_with_meridians: Links - -- ["Using React Native with TypeScript just became simple" on Medium](https://medium.com/@emin93/react-native-typescript-b965059109d3) -- ["24 tips for React Native you probably want to know" on Albert Gao's blog](http://albertgao.xyz/2018/05/30/24-tips-for-react-native-you-probably-want-to-know/#9-For-Typescript) -- ["3 Easy Steps to Set Up React Native with TypeScript, Jest and Enzyme" on Medium by Jan Hesters](https://medium.com/@jan.hesters/3-easy-steps-to-set-up-react-native-with-typescript-jest-and-enzyme-592ca042262f) -- ["Configs to make in an existing React Native project to migrate it to Typescript" - Gist by Italo Menezes](https://gist.github.com/italomlp/4d16bf0f19d09f9fae48d272f9e6306e) - ## :computer: Contributing -Contributions are very welcome. Please check out the [contributing document](https://github.com/emin93/react-native-template-typescript/blob/master/CONTRIBUTING.md). +Contributions are very welcome. Please check out the [contributing document](CONTRIBUTING.md). -### Donations +## :bookmark: License -I created this project in my spare time because I enjoy coding. Of course you can support me by [buying me a coffee](https://www.paypal.me/emin93) if you wish. :coffee: :relieved: +This project is [MIT](LICENSE) licensed.