edit README

This commit is contained in:
Ruidy 2021-09-25 12:15:03 +02:00
parent 16757b2218
commit 2ac94f24f1
7 changed files with 40 additions and 21 deletions

3
.gitignore vendored
View file

@ -1,4 +1,5 @@
build/ build/
node_modules/ node_modules/
/.idea .idea/
.vscode/
.env .env

View file

@ -32,21 +32,21 @@ orientation.
Examples of behavior that contributes to creating a positive environment Examples of behavior that contributes to creating a positive environment
include: include:
* Using welcoming and inclusive language - Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences - Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism - Gracefully accepting constructive criticism
* Focusing on what is best for the community - Focusing on what is best for the community
* Showing empathy towards other community members - Showing empathy towards other community members
Examples of unacceptable behavior by participants include: Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or - The use of sexualized language or imagery and unwelcome sexual attention or
advances advances
* Trolling, insulting/derogatory comments, and personal or political attacks - Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment - Public or private harassment
* Publishing others' private information, such as a physical or electronic - Publishing others' private information, such as a physical or electronic
address, without explicit permission address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a - Other conduct which could reasonably be considered inappropriate in a
professional setting professional setting
### Our Responsibilities ### Our Responsibilities
@ -73,7 +73,7 @@ further defined and clarified by project maintainers.
### Enforcement ### Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All reported by contacting the project team at ruidy.nemausat@gmail.com. All
complaints will be reviewed and investigated and will result in a response that complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident. obligated to maintain confidentiality with regard to the reporter of an incident.

View file

@ -1,6 +1,6 @@
# MIT License # MIT License
Copyright (c) 2020 Ruidy Nemausat Copyright (c) 2021 Ruidy Nemausat
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

View file

@ -1,10 +1,28 @@
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/rjNemo/meal_planner)
# Chef's Meal Planner # Chef's Meal Planner
![header image](https://socialify.git.ci/rjnemo/meal_planner/image?description=1&font=Raleway&language=1&logo=https%3A%2F%2Fchefs-meal-planner.onrender.com%2Flogo192.png&owner=1&pattern=Diagonal%20Stripes&stargazers=1&theme=Dark)
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod&style=for-the-badge)](https://gitpod.io/#https://github.com/rjNemo/meal_planner)
![license](https://img.shields.io/github/license/rjNemo/meal_planner?style=for-the-badge)
![release tag](https://img.shields.io/github/v/release/rjNemo/meal_planner?style=for-the-badge)
Free meal planner for cooks short on ideas! (like me …) Free meal planner for cooks short on ideas! (like me …)
[v.0.1 Available Here!](https://chefs-meal-planner.onrender.com/) ## Demo
[🚀 App live at this address!](https://chefs-meal-planner.onrender.com/)
![Screenshot](docs/short_clip.gif)
### Screenshot
#### Home page
![Screenshot](docs/homepage.png)
#### Meal page
![Screenshot](docs/mealpage.png)
## Feature list ## Feature list

BIN
docs/homepage.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 289 KiB

BIN
docs/mealpage.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 MiB

BIN
docs/short_clip.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 MiB