Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
- traduzindo descrição para inglês
  • Loading branch information
GustavoOly authored Sep 26, 2024
1 parent ca14c02 commit a362843
Showing 1 changed file with 37 additions and 13 deletions.
50 changes: 37 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,48 @@
This system is designed to streamline the management of book rentals. It allows users to efficiently handle book loans, offering key features such as adding, editing, deleting, and filtering loans based on their status ("In Progress," "Overdue," "Returned").

![feature](./resources/gla.png)

Um sistema feito para gestão de aluguel de livros. Com ele, é possível a gestão eficiente de empréstimos de livros, incluindo funcionalidades para adicionar, editar, deletar e filtrar empréstimos conforme a classificação (“Em andamento”, “Atrasado”, “Devolvido”).
---

#### User Installation

#### Instalação para usuários
To install, simply browse the available [releases](https://github.com/GustavoOly/Loaned-book-management-system/releases) and download the version compatible with your operating system. The system offers optimal performance and compatibility with both Windows and Linux.

Navegue em [releases](https://github.com/GustavoOly/Loaned-book-management-system/releases) e baixe a versão correspondente ao seu sistema operacional. No momento o sistema garante uma melhor compatibilidade com Windows e Linux.
---

#### Instalação para desenvolvedores
#### Developer Installation

Todos os recursos utilizados estão especificados em `package.json`.
Para utilizar em sua máquina local, clone o projeto em seu diretório de preferência e execute o seguinte comando:
All dependencies and tools required for development are listed in the package.json file. To run the project locally, follow these steps:

```shell
Clone the repository into your desired directory.
Run the following commands to install dependencies and start the development environment:

```bash
npm install && npm run dev
```
---

#### Contributing

#### Contribuição
We welcome contributions! To add new features or make improvements, follow these steps:

1. Fork the repository.
2. Create a new branch for your feature:

```bash
git checkout -b feature/new-feature
```

3. Commit your changes:

```bash
git commit -am 'Add new feature'
```

4. Push the branch to your repository:

```bash
git push origin feature/new-feature
```

1. Fork o repositório.
2. Crie uma branch para sua feature (`git checkout -b feature/nova-feature`).
3. Commit suas mudanças (`git commit -am 'Adiciona nova feature'`).
4. Push para a branch (`git push origin feature/nova-feature`).
5. Abra um Pull Request.
5. Open a Pull Request to the main repository.

0 comments on commit a362843

Please sign in to comment.