From f6ea1d07712c7ba7c8da5ad9e35728ad13e8f600 Mon Sep 17 00:00:00 2001 From: Neal Burger Date: Sun, 11 Nov 2018 01:36:26 +0100 Subject: [PATCH] Added Readme --- README.md | 44 +++----------------------------------------- 1 file changed, 3 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 897dc83..b5ea293 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,6 @@ -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +When looking around for example applications that use [Mobx 5.x](http://mobx.js.org) combined with [Mobx-react 5.x](https://github.com/mobxjs/mobx-react) and [TypeScript 3.x](http://www.typescriptlang.org/) I did not find any useful example. Most of the examples in the [awesome mobx list](https://github.com/mobxjs/awesome-mobx) reference Mobx 3.x and are really outdated. -## Available Scripts +In my example I will use MOBX to display "Hello World!". It should showcase a couple of core concepts you will be using in an mobx application. -In the project directory, you can run: +Read More about this example [here](https://nealbuerger.com/2018/11/getting-started-with-mobx5-react16-and-typescript3.html). -### `npm start` - -Runs the app in the development mode.
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser. - -The page will reload if you make edits.
-You will also see any lint errors in the console. - -### `npm test` - -Launches the test runner in the interactive watch mode.
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. - -### `npm run build` - -Builds the app for production to the `build` folder.
-It correctly bundles React in production mode and optimizes the build for the best performance. - -The build is minified and the filenames include the hashes.
-Your app is ready to be deployed! - -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. - -### `npm run eject` - -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** - -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. - -Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. - -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. - -## Learn More - -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). - -To learn React, check out the [React documentation](https://reactjs.org/).