Skip to content

Commit

Permalink
docs(README): Update README and fix contrubtion guidelines code highl…
Browse files Browse the repository at this point in the history
…ight (#154)

* chore: Update README screenshots

* docs(README): Expand text regarding contribution.

* docs: Fix syntax highlight error in contribution guidelines

* docs(README): Update to-do list icon
  • Loading branch information
Hanziness committed Jan 13, 2022
1 parent c3caf25 commit 2ae78e7
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ While we also accept translations submitted to the app, currently they are store
2. Copy `i18n/en.js` (to eg. `i18n/hu.js`, if you would be making the Hungarian translation) and translate the strings to your chosen language.
3. Add your language to `nuxt.config.js` (in the `i18n.locales` array). Please make sure to *use the app* as some translations might end up out-of-context if translated blindly. The entry for English translations (stored in `i18n/en.js`) look like this:

```json
```
{ code: 'en', name: 'English', iso: 'en-US', file: 'en.js' }
```

Expand Down
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Free and open-source Pomodoro application, right in your browser.

[<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" width="210">](https://www.buymeacoffee.com/imreg?utm_source=github&utm_medium=web&utm_content=readme)

![Netlify Status](https://api.netlify.com/api/v1/badges/7cb2b7fb-cacd-4acf-803b-8af9dad9f2a8/deploy-status)

![Screenshot of the application showing a work section.](./static/assets/img/ProductImg_Default.png)
Expand Down Expand Up @@ -49,7 +51,7 @@ Here's the looong list of features this app includes.
* control your timer using the keyboard
* dark and light themes
* ... and more to come in the future!
* 📑 **Clean to-do list**
* **Clean to-do list**
* set separate tasks for work, pause and long pause sections
* only shows your top relevant tasks while the timer is running
* automatically remove completed tasks at the end of each session
Expand Down Expand Up @@ -79,6 +81,8 @@ The app itself still does not collect any data (eg. when you're running it on yo
![The percentage timer with the revamped to-do list](./static/assets/img/ProductImg_Percentage.png)
## 🏗 If you're a developer

This is an open-source project that welcomes contributions. Please check the [**contribution guidelines**](./CONTRIBUTING.md) before opening issues, discussions or pull requests!

### ❤ Technologies, packages used

* [**NuxtJS**](https://nuxtjs.org/) (and thus [**VueJS**](https://vuejs.org/))
Expand Down Expand Up @@ -107,3 +111,9 @@ $ yarn dev
# generate the final static site
$ yarn generate
```

## ☕ Support the project

If you like this project or it has helped you, please consider buying the maintainer a coffee. You won't be annoyed to do so while using the app!

[<p align="center"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" width="256"></p>](https://www.buymeacoffee.com/imreg?utm_source=github&utm_medium=web&utm_content=readme)
Binary file modified static/assets/img/ProductImg_Default.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/assets/img/ProductImg_Percentage.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/assets/img/ProductImg_SettingsDark.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2ae78e7

Please sign in to comment.