Skip to content

Commit

Permalink
Merge pull request #7 from skantay/new
Browse files Browse the repository at this point in the history
uploading
  • Loading branch information
skantay authored Mar 24, 2024
2 parents 06902ec + 6487db1 commit e8d3982
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 13 deletions.
19 changes: 19 additions & 0 deletions README.example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# {PROJECT NAME}

- description
- used technologies
- a little more precise description

# Getting Started

- instruction on how to start

# Usage

- list/show available commands

# Docs

- swagger
- erm
- etc...
20 changes: 7 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,13 @@
# {PROJECT NAME}
# REST API - template

- description
- used technologies
- a little more precise description
For who ?

# Getting Started
This template is made for developers who are involved in REST API projects.

- instruction on how to start
Why ?

# Usage
[ba](https://en.wikipedia.org/wiki/Brainfuck)
- list/show available commands
Starting from scratch consumes time, which could be used for coding, but it's not the main point of this template. The main point is that your REST APIs will be standardized, so it gives you a flexibility when rotating between projects.

# Docs
I do not like the way you did this ... Can I contribute ?

- swagger
- erm
- etc...
This repo is open for any improvments and discussion.

0 comments on commit e8d3982

Please sign in to comment.