add readme

README.md

@@ -1,68 +1,38 @@
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
 
-## Available Scripts
 
-In the project directory, you can run:
+# Gilak - Gilaki dictionary | گیلک - دیکشنری گیلکی
 
-### `npm start`
+Gilaki dictionary with more than 4500 words.
 
-Runs the app in the development mode.<br />
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+![Screenshot HomePage](https://github.com/Navid2zp/gilak-desktop/raw/master/public/static/screenshots/1.png)
+![Screenshot WordPage](https://github.com/Navid2zp/gilak-desktop/raw/master/public/static/screenshots/3.png)
 
-The page will reload if you make edits.<br />
-You will also see any lint errors in the console.
+## Running the development version
 
-### `npm test`
+1 - Install dependencies: `npm install`
 
-Launches the test runner in the interactive watch mode.<br />
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+2 - Run react: `npm run start`
 
-### `npm run build`
+3 - Run electron: `npm run electron`
 
-Builds the app for production to the `build` folder.<br />
-It correctly bundles React in production mode and optimizes the build for the best performance.
+## Build for production
 
-The build is minified and the filenames include the hashes.<br />
-Your app is ready to be deployed!
+`npm run dist`
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+Results will be in `dist` folder.
 
-### `npm run eject`
+### Database
 
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+Database file is located at `/db/dictionary.db`. It's a sqlite database file.
 
-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.
+### Source
 
-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.
+Source for the words is `gdic.ir`
 
-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.
+### Android
 
-## Learn More
+Android version is available on Google Play: https://play.google.com/store/apps/details?id=studio.arvix.gilak
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+### License
 
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
-
-### Analyzing the Bundle Size
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
-
-### Making a Progressive Web App
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
-
-### Advanced Configuration
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
-
-### Deployment
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
-
-### `npm run build` fails to minify
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
+MIT License