diff --git a/.github/workflows/persian-wordle-workflow.yml b/.github/workflows/persian-wordle-workflow.yml new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md index 01edc83..236d891 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -## Persian Wordle a Parody of Wordle +# Persian Wordle -An application used to TypeScript , React-JS , TailwindCss , Persian words Dictanary +A fun and challenging word puzzle game to improve your Persian vocabulary ![Persian wordle Screen Capture](images/PersianWordleLogo.jpg) @@ -8,15 +8,49 @@ An application used to TypeScript , React-JS , TailwindCss , Persian words Dicta you can play persian wordle an https://persianwordle.github.io -## Project Status - -This project is currently in development. can you HELP me ? - -## Installation and Setup Instructions - - -### Clone down this repository. -You will need `node` and `npm` installed globally on your machine. +## Built With +- TypeScript +- ReactJS +- TailwindCSS +- PostCSS +- Persian Word Dictionary + +## Features +- Find hidden words in the grid +- Improve your Persian vocabulary +- Share your score on social media +- Compete with friends +- Fast and responsive on any device + +## How to play +- Input your own words or use the built-in Persian word dictionary +- Find the hidden words in the grid +- Score points for each word found +- Share your score on social media and compete with friends + +## Hosting +This game is hosted on a static hosting service, so you can be sure that it will be fast and reliable + +## Contribution +- Fork the repository +- Create a new branch for your feature (`git checkout -b feature/new-feature`) +- Make your changes +- Commit your changes (`git commit -am 'Add some new feature'`) +- Push to the branch (`git push origin feature/new-feature`) +- Create a new pull request + + +Please note that this is just a sample markdown file and it may require additional modification or updating depending on the current status of your project. + +## How to PR +- Fork the repository +- Create a new branch for your feature (`git checkout -b feature/new-feature`) +- Make your changes +- Commit your changes (`git commit -am 'Add some new feature'`) +- Push to the branch (`git push origin feature/new-feature`) +- Create a new pull request + +You can also submit an issue if you find any bug or have any suggestions for the game. Installation: @@ -34,4 +68,4 @@ To Visit PersianWordle: `localhost:3000` -![Persian wordle main](images/screencapture-main.png) \ No newline at end of file +![Persian wordle main](images/screencapture-main.png) diff --git a/build/PersianWordle.ico b/build/PersianWordle.ico deleted file mode 100644 index b459b99..0000000 Binary files a/build/PersianWordle.ico and /dev/null differ diff --git a/build/asset-manifest.json b/build/asset-manifest.json deleted file mode 100644 index 8b497df..0000000 --- a/build/asset-manifest.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "files": { - "main.css": "/static/css/main.3d60e7aa.css", - "main.js": "/static/js/main.21871efa.js", - "static/media/Shabnam.ttf": "/static/media/Shabnam.5b9b09c283c263361c6d.ttf", - "index.html": "/index.html", - "main.3d60e7aa.css.map": "/static/css/main.3d60e7aa.css.map", - "main.21871efa.js.map": "/static/js/main.21871efa.js.map" - }, - "entrypoints": [ - "static/css/main.3d60e7aa.css", - "static/js/main.21871efa.js" - ] -} \ No newline at end of file diff --git a/build/index.html b/build/index.html deleted file mode 100644 index 785e933..0000000 --- a/build/index.html +++ /dev/null @@ -1 +0,0 @@ -
\r\n {message}\r\n
\r\n