Moffinguer / Templates

This is a repository that holds several templates for diferent subjects. Since hooks, documents structure for proyects, etc...

Template

This is a tempalte with examples on how to write a README file

Preparation

Explain which software or requirements we need, before proceeding to the instalation.

• Step 1
• Step 2
  • Aditional steps
    • More aditional Steps
• Step 3

Installation

Every command to execute has to be printed in a textbox like the one down

apt install example

If it requires an explanation, under each textbox, a description can be made

Usage

Feature 1

example code to execute

Feature 2

example 2 code to execute

API calls

METHOD	Resource	Input	Response
POST
PUT
DELETE
GET

API Objects

Object 1

Field	Type	Description

{
    "valor": "valor",
    "valor2": 5
}

Contributing

Insert here contribution policy

License

MIT License

Copyright (c) 2023 Moffinguer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.