Skip to content

Commit bf89db1

Browse files
authored
updating readme to new format
refer new format at this iteration of readme proffapt/myREADME@2873e21
1 parent 635e175 commit bf89db1

1 file changed

Lines changed: 30 additions & 44 deletions

File tree

README.md

Lines changed: 30 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,9 @@
4545
<li><a href="#usage">Usage</a></li>
4646
<li><a href="#integrating-with-vscode">Integrating with vscode</a></li>
4747
<li><a href="#integrating-with-vim">Integrating with vim</a></li>
48-
<li><a href="#contributing">Contributing</a></li>
49-
<li><a href="#changelog">Change.log</a></li>
50-
<li><a href="#license">License</a></li>
5148
<li><a href="#contact">Contact</a></li>
5249
<li><a href="#acknowledgments">Acknowledgments</a></li>
50+
<li><a href="#miscelleneous">Miscelleneous</a></li>
5351
</ol>
5452
</details>
5553

@@ -156,50 +154,28 @@ I made a custom keybinding to work with my code-runner on vim, add the lines fro
156154

157155
<p align="right">(<a href="#top">back to top</a>)</p>
158156

159-
<!-- CONTRIBUTING -->
160-
## Contributing
161-
162-
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
163-
164-
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
165-
Don't forget to give the project a star! Thanks again!
166-
167-
1. Fork the Project
168-
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
169-
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
170-
4. Push to the Branch (`git push origin feature/AmazingFeature`)
171-
5. Open a Pull Request
172-
173-
<p align="right">(<a href="#top">back to top</a>)</p>
174-
175-
176-
<!-- Changelog -->
177-
# Changelog
178-
179-
## v1.1.5
180-
181-
### Added or Changed
182-
- Added basic support for go-lang.
183-
184-
<p align="right">(<a href="#top">back to top</a>)</p>
185-
186-
187-
<!-- LICENSE -->
188-
## License
189-
190-
Distributed under the BSD-2-Clause License. See `LICENSE.txt` for more information.
191-
192-
<p align="right">(<a href="#top">back to top</a>)</p>
193-
194-
195157
<!-- CONTACT -->
196158
## Contact
197159

198-
Arpit Bhardwaj - [Twitter](https://twitter.com/proffapt) - [Telegram](https://t.me/proffapt) - proffapt@protonmail.com
199-
200-
Company website: [Cybernity](https://cybernity.org) - [CybernityForum](https://cybernity.group)
201-
202-
Project Link: [https://github.com/proffapt/code-runner](https://github.com/proffapt/code-runner)
160+
<p>
161+
📫 Arpit Bhardwaj ( aka proffapt ) -
162+
163+
<a href="https://twitter.com/proffapt">
164+
<img align="center" alt="proffapt's Twitter " width="22px" src="https://raw.githubusercontent.com/edent/SuperTinyIcons/master/images/svg/twitter.svg" />
165+
</a>
166+
<a href="https://t.me/proffapt">
167+
<img align="center" alt="proffapt's Telegram" width="22px" src="https://raw.githubusercontent.com/edent/SuperTinyIcons/master/images/svg/telegram.svg" />
168+
</a>
169+
<a href="https://www.linkedin.com/in/proffapt/">
170+
<img align="center" alt="proffapt's LinkedIn" width="22px" src="https://raw.githubusercontent.com/edent/SuperTinyIcons/master/images/svg/linkedin.svg" />
171+
</a>
172+
<a href="mailto:proffapt@pm.me">
173+
<img align="center" alt="proffapt's mail" width="22px" src="https://raw.githubusercontent.com/edent/SuperTinyIcons/master/images/svg/mail.svg" />
174+
</a>
175+
<a href="https://cybernity.group">
176+
<img align="center" alt="proffapt's forum for cybernity" width="22px" src="https://cybernity.group/uploads/default/original/1X/a8338f86bbbedd39701c85d5f32cf3d817c04c27.png" />
177+
</a>
178+
</p>
203179

204180
<p align="right">(<a href="#top">back to top</a>)</p>
205181

@@ -210,7 +186,17 @@ Project Link: [https://github.com/proffapt/code-runner](https://github.com/proff
210186
* [Choose an Open Source License](https://choosealicense.com)
211187
* [Img Shields](https://shields.io)
212188
* [Bash filename manipulation](https://stackoverflow.com/a/965069)
189+
<!-- UPDATE -->
190+
191+
<p align="right">(<a href="#top">back to top</a>)</p>
192+
193+
## Miscelleneous
213194

195+
Do consider looking at other paradigms of this documentation
196+
- [Change-logs](CHANGELOG.md)
197+
- [License used](LICENSE.txt)
198+
- [Code Of Conduct](CODE_OF_CONDUCT.md)
199+
- [How to contribute?](CONTRIBUTING.md)
214200

215201
<p align="right">(<a href="#top">back to top</a>)</p>
216202

0 commit comments

Comments
 (0)