Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Avivhdr committed Oct 21, 2021
1 parent 179e6b7 commit fe8c4cb
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
@@ -1,22 +1,23 @@
## <Project Name>
## PROJECT X
![GitHub repo size](https://img.shields.io/github/repo-size/scottydocs/README-template.md)

###<project_name> is a <utility/tool/feature> that allows <insert_target_audience> to do <action/task_it_does>.
###<project_name> is trying to solve the problem of <problem> by achiving <Achivment goals>
### PROJECT X is a <utility/tool/feature> that allows <insert_target_audience> to do <action/task_it_does>.

## <This proje> is ment to use by <Consumer (costumer/ui projects/POSE employees)>
### PROJECT X is trying to solve the problem of <problem> by achiving <Achivment goals>

## PROJECT X is ment to use by <Consumer (costumer/ui projects/POSE employees)>

## Prerequisites
Before you begin, ensure you have met the following requirements
<list of requirements>

## Instructions
This is how to run/build/add <project_name>:
This is how to run/build/add PROJECT X:
<instructions>

## Usage:
This is how to use <project_name>
This is how to use PROJECT X
<If the project has an API, this is the place to go into details about it>

## Ownersip
This project is owned by the [<team name>](<team github link>)
This project is owned by the <link to team Githubs page>

0 comments on commit fe8c4cb

Please sign in to comment.