├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── README.md
└── ashiish-icon.png
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # CHANGELOG
2 |
3 | - Updated content.
4 |
5 | Initial Release
6 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | In the interest of fostering an open and welcoming environment, we as
6 | contributors and maintainers pledge to making participation in our project and
7 | our community a harassment-free experience for everyone, regardless of age, body
8 | size, disability, ethnicity, sex characteristics, gender identity and expression,
9 | level of experience, education, socio-economic status, nationality, personal
10 | appearance, race, religion, or sexual identity and orientation.
11 |
12 | ## Our Standards
13 |
14 | Examples of behavior that contributes to creating a positive environment
15 | include:
16 |
17 | * Using welcoming and inclusive language
18 | * Being respectful of differing viewpoints and experiences
19 | * Gracefully accepting constructive criticism
20 | * Focusing on what is best for the community
21 | * Showing empathy towards other community members
22 |
23 | Examples of unacceptable behavior by participants include:
24 |
25 | * The use of sexualized language or imagery and unwelcome sexual attention or
26 | advances
27 | * Trolling, insulting/derogatory comments, and personal or political attacks
28 | * Public or private harassment
29 | * Publishing others' private information, such as a physical or electronic
30 | address, without explicit permission
31 | * Other conduct which could reasonably be considered inappropriate in a
32 | professional setting
33 |
34 | ## Our Responsibilities
35 |
36 | Project maintainers are responsible for clarifying the standards of acceptable
37 | behavior and are expected to take appropriate and fair corrective action in
38 | response to any instances of unacceptable behavior.
39 |
40 | Project maintainers have the right and responsibility to remove, edit, or
41 | reject comments, commits, code, wiki edits, issues, and other contributions
42 | that are not aligned to this Code of Conduct, or to ban temporarily or
43 | permanently any contributor for other behaviors that they deem inappropriate,
44 | threatening, offensive, or harmful.
45 |
46 | ## Scope
47 |
48 | This Code of Conduct applies both within project spaces and in public spaces
49 | when an individual is representing the project or its community. Examples of
50 | representing a project or community include using an official project e-mail
51 | address, posting via an official social media account, or acting as an appointed
52 | representative at an online or offline event. Representation of a project may be
53 | further defined and clarified by project maintainers.
54 |
55 | ## Enforcement
56 |
57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
58 | reported by contacting the project team at logiicode@outlook.com. All
59 | complaints will be reviewed and investigated and will result in a response that
60 | is deemed necessary and appropriate to the circumstances. The project team is
61 | obligated to maintain confidentiality with regard to the reporter of an incident.
62 | Further details of specific enforcement policies may be posted separately.
63 |
64 | Project maintainers who do not follow or enforce the Code of Conduct in good
65 | faith may face temporary or permanent repercussions as determined by other
66 | members of the project's leadership.
67 |
68 | ## Attribution
69 |
70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72 |
73 | [homepage]: https://www.contributor-covenant.org
74 |
75 | For answers to common questions about this code of conduct, see
76 | https://www.contributor-covenant.org/faq
77 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing
2 |
3 | Add details regarding contrubution.
4 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | 
4 |
5 |
6 | Readme
7 |
8 | Readme is a documentation for creating organized documentation of any project. The logo size used for this documentation is `150 x 150` size. Go through the installation section to start using this documentation for your project. If you have many contents, start with Table Of Contents.
9 |
10 | The project comes with Code Of Conduct, Contributing and Changelog file to help you make your documentation more in depth.
11 |
12 |
13 | ## Table Of Contents
14 | - [Prerequisites](#prerequisites)
15 | - [Installation](#installation)
16 | - [Demo](#demo)
17 | - [Tests](#tests)
18 | - [Author](#author)
19 | - [Contributors](#contributors)
20 | - [Contribution](#contribution)
21 | - [License](#license)
22 | - [Additional Details / References](#additional-details--references)
23 | - [Changelog](#changelog)
24 |
25 | ## Prerequisites
26 |
27 | If your project needs any prerequisites or dependencies, list them here.
28 |
29 | ```
30 | Example to install dependencies
31 | ```
32 |
33 | ## Installation
34 |
35 | Download the readme file using `wget / curl` and start editing according to your need.
36 |
37 | ```
38 | wget https://raw.githubusercontent.com/ashiishme/readme/master/README.md -O README.md
39 | ```
40 |
41 | ```
42 | curl https://raw.githubusercontent.com/ashiishme/readme/master/README.md > README.md
43 | ```
44 |
45 | You can `fork` the project.
46 |
47 | [](https://github.com/ashiishme/readme/fork)
48 |
49 | You can clone the whole project.
50 |
51 | ```
52 | git clone https://github.com/ashiishme/readme.git
53 | ```
54 |
55 | ## Demo
56 |
57 | Add demo of the projects. It can be any format ( link | image | gif | video ).
58 |
59 | ## Tests
60 |
61 | There are no test avaiable for this project. Details about the necessary of test can be very useful.
62 |
63 | ## Author
64 |
65 | **Author Name** : Ashish Yadav
66 | **Author URI** : [www.ashiish.me](https://www.ashiish.me)
67 | **GitHub URI** : [ashiishme](https://github.com/ashiishme)
68 |
69 | ## Contributors
70 |
71 | List of all Contributors:
72 | - [contributor name](#)
73 |
74 | ## Contribution
75 |
76 | This project is to help Individuals / organization to quickly setup a documentation or readme. If you want to contribute, pull requests are always welcome.
77 |
78 | Check the [installation](#installation) section to start contributing to this project.
79 |
80 | **Sample list below**
81 |
82 | - [CODE OF CONDUCT](CODE_OF_CONDUCT.md)
83 | - [CONTRIBUTING](CONTRIBUTING.md)
84 |
85 | ## License
86 |
87 | [](https://opensource.org/licenses/MIT)
88 |
89 |
90 | ## Additional Details / References
91 |
92 | - Additional details to the projects or the reference to similar projects.
93 |
94 | ## Changelog
95 |
96 | [CHANGELOG.md](CHANGELOG.md)
97 |
98 |
99 | ---
100 |
101 | Thank you for using this documentation. If you love this project give it a star.
102 |
103 | [](https://github.com/ashiishme/readme)
104 |
--------------------------------------------------------------------------------
/ashiish-icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ashiishme/readme/2901dce22f227c3e17b332d00cf9c7ee5219a041/ashiish-icon.png
--------------------------------------------------------------------------------