Skip to content

Commit 4313ce8

Browse files
Update readme
1 parent c2f2dfb commit 4313ce8

File tree

1 file changed

+26
-181
lines changed

1 file changed

+26
-181
lines changed

README.md

Lines changed: 26 additions & 181 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,12 @@
11
<a name="readme-top"></a>
22

3-
<!--
4-
!!! IMPORTANT !!!
5-
This README is an example of how you could professionally present your codebase.
6-
Writing documentation is a crucial part of your work as a professional software developer and cannot be ignored.
7-
8-
You should modify this file to match your project and remove sections that don't apply.
9-
10-
REQUIRED SECTIONS:
11-
- Table of Contents
12-
- About the Project
13-
- Built With
14-
- Live Demo
15-
- Getting Started
16-
- Authors
17-
- Future Features
18-
- Contributing
19-
- Show your support
20-
- Acknowledgements
21-
- License
22-
23-
OPTIONAL SECTIONS:
24-
- FAQ
25-
26-
After you're finished please remove all the comments and instructions!
27-
28-
For more information on the importance of a professional README for your repositories: https://github.com/microverseinc/curriculum-transversal-skills/blob/main/documentation/articles/readme_best_practices.md
29-
-->
30-
313
<div align="center">
32-
<!-- You are encouraged to replace this logo with your own! Otherwise you can also remove it. -->
33-
<img src="murple_logo.png" alt="logo" width="140" height="auto" />
34-
<br/>
354

36-
<h3><b>Microverse README Template</b></h3>
5+
<img src="https://github.com/carreraprogrammer/To-do-List/blob/master/carrera_logo.png?raw=true" alt="logo" width="140" height="auto" />
6+
<br/>
377

388
</div>
399

40-
<!-- TABLE OF CONTENTS -->
4110

4211
# 📗 Table of Contents
4312

@@ -47,245 +16,121 @@ For more information on the importance of a professional README for your reposit
4716
- [Key Features](#key-features)
4817
- [🚀 Live Demo](#live-demo)
4918
- [💻 Getting Started](#getting-started)
50-
- [Prerequisites](#prerequisites)
5119
- [Setup](#setup)
20+
- [Prerequisites](#prerequisites)
5221
- [Install](#install)
5322
- [Usage](#usage)
5423
- [Run tests](#run-tests)
55-
- [Deployment](#deployment)
24+
- [Deployment](#triangular_flag_on_post-deployment)
5625
- [👥 Authors](#authors)
5726
- [🔭 Future Features](#future-features)
5827
- [🤝 Contributing](#contributing)
5928
- [⭐️ Show your support](#support)
6029
- [🙏 Acknowledgements](#acknowledgements)
61-
- [❓ FAQ (OPTIONAL)](#faq)
30+
- [❓ FAQ](#faq)
6231
- [📝 License](#license)
6332

64-
<!-- PROJECT DESCRIPTION -->
65-
66-
# 📖 [your_project_name] <a name="about-project"></a>
33+
# 📖 [WORLD CUP DB] <a name="about-project"></a>
6734

68-
> Describe your project in 1 or 2 sentences.
6935

70-
**[your_project__name]** is a...
36+
**[WORLD CUP DB]** is a web application, where I create a Bash script that enters information from World Cup games into PostgreSQL, then query the database for useful statistics.
7137

7238
## 🛠 Built With <a name="built-with"></a>
7339

7440
### Tech Stack <a name="tech-stack"></a>
7541

76-
> Describe the tech stack and include only the relevant sections that apply to your project.
77-
78-
<details>
79-
<summary>Client</summary>
80-
<ul>
81-
<li><a href="https://reactjs.org/">React.js</a></li>
82-
</ul>
83-
</details>
42+
The following technologies were used in the development of this project:
8443

85-
<details>
86-
<summary>Server</summary>
87-
<ul>
88-
<li><a href="https://expressjs.com/">Express.js</a></li>
89-
</ul>
90-
</details>
44+
Ruby: To create and manipulate the classes
9145

92-
<details>
93-
<summary>Database</summary>
94-
<ul>
95-
<li><a href="https://www.postgresql.org/">PostgreSQL</a></li>
96-
</ul>
97-
</details>
98-
99-
<!-- Features -->
10046

10147
### Key Features <a name="key-features"></a>
10248

103-
> Describe between 1-3 key features of the application.
104-
105-
- **[key_feature_1]**
106-
- **[key_feature_2]**
107-
- **[key_feature_3]**
49+
- **You can add world cup information**
50+
- **You can obtain worldcup information**
51+
- **You can add information to the database using a script**
10852

10953
<p align="right">(<a href="#readme-top">back to top</a>)</p>
11054

111-
<!-- LIVE DEMO -->
112-
113-
## 🚀 Live Demo <a name="live-demo"></a>
114-
115-
> Add a link to your deployed project.
116-
117-
- [Live Demo Link](https://google.com)
118-
119-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
120-
121-
<!-- GETTING STARTED -->
122-
12355
## 💻 Getting Started <a name="getting-started"></a>
12456

125-
> Describe how a new developer could make use of your project.
12657

12758
To get a local copy up and running, follow these steps.
12859

12960
### Prerequisites
13061

13162
In order to run this project you need:
13263

133-
<!--
134-
Example command:
13564

13665
```sh
137-
gem install rails
66+
psql -U postgres < worldcup.sql
13867
```
139-
-->
14068

14169
### Setup
14270

14371
Clone this repository to your desired folder:
14472

145-
<!--
146-
Example commands:
14773

14874
```sh
14975
cd my-folder
150-
git clone git@github.com:myaccount/my-project.git
76+
git clone git@github.com:carreraprogrammer/world_cup_database.git
15177
```
152-
--->
153-
154-
### Install
155-
156-
Install this project with:
157-
158-
<!--
159-
Example command:
160-
161-
```sh
162-
cd my-project
163-
gem install
164-
```
165-
--->
16678

16779
### Usage
16880

16981
To run the project, execute the following command:
17082

171-
<!--
172-
Example command:
173-
17483
```sh
175-
rails server
84+
./insert_data.sh
17685
```
177-
--->
178-
179-
### Run tests
18086

181-
To run tests, run the following command:
182-
183-
<!--
184-
Example command:
185-
186-
```sh
187-
bin/rails test test/models/article_test.rb
188-
```
189-
--->
190-
191-
### Deployment
192-
193-
You can deploy this project using:
194-
195-
<!--
196-
Example:
197-
198-
```sh
199-
200-
```
201-
-->
20287

20388
<p align="right">(<a href="#readme-top">back to top</a>)</p>
20489

205-
<!-- AUTHORS -->
206-
20790
## 👥 Authors <a name="authors"></a>
20891

209-
> Mention all of the collaborators of this project.
210-
211-
👤 **Author1**
21292

213-
- GitHub: [@githubhandle](https://github.com/githubhandle)
214-
- Twitter: [@twitterhandle](https://twitter.com/twitterhandle)
215-
- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)
93+
👤 **Daniel Carrera**
94+
95+
- GitHub: [@carreraprogrammer](https://github.com/carreraprogrammer)
96+
- Twitter: [@carreraprogrammer](https://twitter.com/carreraprog)
97+
- LinkedIn: [Daniel Carrera] (https://www.linkedin.com/in/daniel-carrera-paz-85a917244/)
21698

217-
👤 **Author2**
218-
219-
- GitHub: [@githubhandle](https://github.com/githubhandle)
220-
- Twitter: [@twitterhandle](https://twitter.com/twitterhandle)
221-
- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)
22299

223100
<p align="right">(<a href="#readme-top">back to top</a>)</p>
224101

225-
<!-- FUTURE FEATURES -->
226-
227102
## 🔭 Future Features <a name="future-features"></a>
228103

229-
> Describe 1 - 3 features you will add to the project.
230-
231-
- [ ] **[new_feature_1]**
232-
- [ ] **[new_feature_2]**
233-
- [ ] **[new_feature_3]**
104+
- [ ] **[Add basic UI]**
234105

235106
<p align="right">(<a href="#readme-top">back to top</a>)</p>
236107

237-
<!-- CONTRIBUTING -->
238-
239108
## 🤝 Contributing <a name="contributing"></a>
240109

241110
Contributions, issues, and feature requests are welcome!
242111

243-
Feel free to check the [issues page](../../issues/).
112+
Feel free to check the [issues page](https://github.com/carreraprogrammer/school/issues/).
244113

245114
<p align="right">(<a href="#readme-top">back to top</a>)</p>
246115

247-
<!-- SUPPORT -->
248116

249117
## ⭐️ Show your support <a name="support"></a>
250118

251-
> Write a message to encourage readers to support your project
252119

253-
If you like this project...
120+
If you like this project, I'd really appreciate if you can give me a star.
254121

255122
<p align="right">(<a href="#readme-top">back to top</a>)</p>
256123

257-
<!-- ACKNOWLEDGEMENTS -->
258-
259124
## 🙏 Acknowledgments <a name="acknowledgements"></a>
260125

261-
> Give credit to everyone who inspired your codebase.
262126

263-
I would like to thank...
127+
I would like to thank to my family, my coding partners and Microverse, that are always pushing me to became my best version
264128

265129
<p align="right">(<a href="#readme-top">back to top</a>)</p>
266130

267-
<!-- FAQ (optional) -->
268-
269-
## ❓ FAQ (OPTIONAL) <a name="faq"></a>
270-
271-
> Add at least 2 questions new developers would ask when they decide to use your project.
272-
273-
- **[Question_1]**
274-
275-
- [Answer_1]
276-
277-
- **[Question_2]**
278-
279-
- [Answer_2]
280-
281-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
282-
283-
<!-- LICENSE -->
284131

285132
## 📝 License <a name="license"></a>
286133

287-
This project is [MIT](./LICENSE) licensed.
288-
289-
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._
134+
This project is [MIT](MIT.md) licensed.
290135

291-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
136+
<p align="right">(<a href="#readme-top">back to top</a>)</p>

0 commit comments

Comments
 (0)