Skip to content

Commit

Permalink
Readme toc (#347)
Browse files Browse the repository at this point in the history
  • Loading branch information
PragTob authored Sep 16, 2024
1 parent 6b86247 commit 8ad8d42
Showing 1 changed file with 25 additions and 8 deletions.
33 changes: 25 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@

Create a challenge. Ready? Brainstorm. mindwendel helps you to easily brainstorm and upvote ideas and thoughts within your team. Built from scratch with [Phoenix](https://www.phoenixframework.org).

- [mindwendel](#mindwendel)
- [Features](#features)
- [Use-cases](#use-cases)
- [Getting Started](#getting-started)
- [Contributing](#contributing)
- [Workflow](#workflow)
- [Development](#development)
- [Testing](#testing)
- [Production](#production)
- [Note](#note)
- [Build release and production docker image](#build-release-and-production-docker-image)
- [Formatting](#formatting)
- [Environment Variables](#environment-variables)
- [Localization](#localization)
- [Testimonials](#testimonials)
- [Acknowledgements](#acknowledgements)

## Features

- 5 minute setup (It is not a joke)
Expand Down Expand Up @@ -63,6 +80,14 @@ mindwendel is built on top of:
- [Phoenix LiveView](https://github.com/phoenixframework/phoenix_live_view)
- [PostgreSQL](https://www.postgresql.org)

### Workflow

1. Fork it (<https://github.com/mindwendel/mindwendel/fork>)
2. Create your feature branch (`git checkout -b fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin fooBar`)
5. Create a new Pull Request

### Development

- Startup docker compose setup
Expand Down Expand Up @@ -182,14 +207,6 @@ You can extract new strings to translate by running:
mix gettext.extract --merge
```

## Contributing

1. Fork it (<https://github.com/mindwendel/mindwendel/fork>)
2. Create your feature branch (`git checkout -b fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin fooBar`)
5. Create a new Pull Request

## Testimonials

<img src="https://www.nibis.de/img/nlq-medienbildung.png" align="left" style="margin-right:20px">
Expand Down

0 comments on commit 8ad8d42

Please sign in to comment.