Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
guilherm-hsbe authored May 31, 2024
1 parent 4bd5dda commit b92d926
Showing 1 changed file with 3 additions and 39 deletions.
42 changes: 3 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,21 @@
## Índice
1. [Visão Geral](#visão-geral)
1. [Dependências](#dependências)
1. [Instalação](#instalação)
1. [Utilização](#utilização)
1. [Funcionalidades](#funcionalidades)
1. [Equipe](#equipe)
1. [Contribuição](#contribuição)
1. [Licença](#licença)
1. [Feedback](#feedback)
1. [Contato](#contato)


## Visão Geral
Plataforma de um conjunto diversificado de ferramentas e recursos relacionados à segurança, geração de códigos e outros elementos.

## Dependências
Neste projeto, são utilizadas algumas bibliotecas e recursos de terceiros para melhorar o design e a funcionalidade do site. Abaixo estão as principais dependências:
Principais dependências deste projeto:

- [Bootstrap](https://getbootstrap.com/): Utilizado para o estilo responsivo do site.
- [Font Awesome](https://fontawesome.com/): Fornece uma coleção de ícones de alta qualidade usados na interface.
- [SVG Repo](https://www.svgrepo.com/): Fornece uma coleção variada de ícones usados na interface.
- [Product & Project Managers Illustrations](https://www.drawkit.com/illustrations/product-project-managers-illustrations): Conjunto de SVGs gratuítos da [DrawKit](https://www.drawkit.com/) para determinados elementos do site.

## Instalação
Você pode baixar este repositório diretamente por [este link](https://github.com/guilherm-hsbe/BranchKit/archive/refs/heads/main.zip) e em seguida descompactá-lo. Opcionalmente, se possuir o [git](https://git-scm.com/downloads) instalado em sua máquina/dispositivo, você pode clonar o respositório através do terminal. Siga o passo-a-passo:

```bash
# Clone o repositório
git clone https://github.com/guilherm-hsbe/BranchKit
Expand All @@ -35,49 +26,22 @@ git clone https://github.com/guilherm-hsbe/BranchKit
cd BranchKit
```

## Utilização
Para utilizar os recursos desenvolvidos neste projeto, basta seguir o link do deploy: https://guilherm-hsbe.github.io/BranchKit/

## Funcionalidades
As funcionalidades principais incluem: `[o projeto ainda não possui funcionalidades concretamente estabelecidas ou desenvolvidas]`
As funcionalidades principais incluem: `[o projeto ainda não possui funcionalidades]`

<!--
- Funcionalidade A: breve descrição.
- Funcionalidade B: breve descrição.
- Funcionalidade C: breve descrição.
-->

## Equipe
Os desenvolvedores deste projeto são:

- Guilherme Henrique
- Função: Dono/Desenvolvedor
- Contato: [guilherm-hsbe](https://github.com/guilherm-hsbe)

## Contribuição
Você pode contribuir com este projeto seguindo as seguintes diretrizes:

- Relate problemas [aqui](https://github.com/guilherm-hsbe/Branch-Kit/issues).
- Contribua com código criando uma solicitação de pull.
<!--
- Siga as diretrizes de estilo de código especificadas no arquivo `CONTRIBUTING.md`.
-->

## Licença
Este projeto é licenciado sob a Licença MIT - consulte o arquivo [LICENSE](https://github.com/guilherm-hsbe/BranchKit/blob/main/LICENSE) para obter mais detalhes.
Projeto licenciado sob a Licença MIT - consulte o arquivo [LICENSE](https://github.com/guilherm-hsbe/BranchKit/blob/main/LICENSE) para obter mais detalhes.

<!--
> Você é incentivado a colaborar e contribuir para o desenvolvimento deste projeto[...] <br>
`Não é permitido [...]`
-->

## Feedback
Se você visualizou a plataforma ou tem algum feedback, sugestão ou ideia para compartilhar, basta entrar em contato! Seu feedback é importante, pois ajuda a aprimorar os recursos oferecidos.

> Caso tenha encontrado algum problema técnico ou identificado bugs durante a utilização, por favor, relate através da seção de **issues** no repositório do GitHub.
## Contato
Para entrar em contato diretamente, você pode utilizar um dos seguintes canais:

- E-mail: [guilherm3hsb@gmail.com](mailto:guilherm3hsb@gmail.com)
- GitHub: [guilherm-hsbe](https://github.com/guilherm-hsbe)

0 comments on commit b92d926

Please sign in to comment.