From f67b2c039f8b60780e8f20bde9146bbe72613b9f Mon Sep 17 00:00:00 2001 From: Akshay Nair Date: Sun, 29 Sep 2024 16:59:06 +0530 Subject: Readme update --- README.md | 86 ++++++++-------------------------------------- media/screenshot-apps.png | Bin 0 -> 136416 bytes media/screenshot-home.png | Bin 0 -> 60713 bytes 3 files changed, 14 insertions(+), 72 deletions(-) create mode 100644 media/screenshot-apps.png create mode 100644 media/screenshot-home.png diff --git a/README.md b/README.md index 12470c3..c54bfd2 100644 --- a/README.md +++ b/README.md @@ -1,79 +1,21 @@ -This is a new [**React Native**](https://reactnative.dev) project, bootstrapped using [`@react-native-community/cli`](https://github.com/react-native-community/cli). +# Owyn launcher +Owyn (_Only What You Need_) launcher is a minimal launcher for android -# Getting Started ->**Note**: Make sure you have completed the [React Native - Environment Setup](https://reactnative.dev/docs/environment-setup) instructions till "Creating a new application" step, before proceeding. +## What I need from my launcher... +* A clock +* A searchable list of apps +* Quick access to favorite apps +* Ability to uninstall apps -## Step 1: Start the Metro Server -First, you will need to start **Metro**, the JavaScript _bundler_ that ships _with_ React Native. +## Screenshots +| Home | App list | +|------|----------| +| ![Screenshots](media/screenshot-home.png) | ![Screenshots](media/screenshot-apps.png) | -To start Metro, run the following command from the _root_ of your React Native project: -```bash -# using npm -npm start +## Install +Not available on play store and never will be. +Grab an apk from the [releases section](https://github.com/phenax/owyn-launcher/releases) and install it. -# OR using Yarn -yarn start -``` - -## Step 2: Start your Application - -Let Metro Bundler run in its _own_ terminal. Open a _new_ terminal from the _root_ of your React Native project. Run the following command to start your _Android_ or _iOS_ app: - -### For Android - -```bash -# using npm -npm run android - -# OR using Yarn -yarn android -``` - -### For iOS - -```bash -# using npm -npm run ios - -# OR using Yarn -yarn ios -``` - -If everything is set up _correctly_, you should see your new app running in your _Android Emulator_ or _iOS Simulator_ shortly provided you have set up your emulator/simulator correctly. - -This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively. - -## Step 3: Modifying your App - -Now that you have successfully run the app, let's modify it. - -1. Open `App.tsx` in your text editor of choice and edit some lines. -2. For **Android**: Press the R key twice or select **"Reload"** from the **Developer Menu** (Ctrl + M (on Window and Linux) or Cmd ⌘ + M (on macOS)) to see your changes! - - For **iOS**: Hit Cmd ⌘ + R in your iOS Simulator to reload the app and see your changes! - -## Congratulations! :tada: - -You've successfully run and modified your React Native App. :partying_face: - -### Now what? - -- If you want to add this new React Native code to an existing application, check out the [Integration guide](https://reactnative.dev/docs/integration-with-existing-apps). -- If you're curious to learn more about React Native, check out the [Introduction to React Native](https://reactnative.dev/docs/getting-started). - -# Troubleshooting - -If you can't get this to work, see the [Troubleshooting](https://reactnative.dev/docs/troubleshooting) page. - -# Learn More - -To learn more about React Native, take a look at the following resources: - -- [React Native Website](https://reactnative.dev) - learn more about React Native. -- [Getting Started](https://reactnative.dev/docs/environment-setup) - an **overview** of React Native and how setup your environment. -- [Learn the Basics](https://reactnative.dev/docs/getting-started) - a **guided tour** of the React Native **basics**. -- [Blog](https://reactnative.dev/blog) - read the latest official React Native **Blog** posts. -- [`@facebook/react-native`](https://github.com/facebook/react-native) - the Open Source; GitHub **repository** for React Native. diff --git a/media/screenshot-apps.png b/media/screenshot-apps.png new file mode 100644 index 0000000..e9cdb40 Binary files /dev/null and b/media/screenshot-apps.png differ diff --git a/media/screenshot-home.png b/media/screenshot-home.png new file mode 100644 index 0000000..ffcba57 Binary files /dev/null and b/media/screenshot-home.png differ -- cgit v1.3.1