Skip to content

Commit

Permalink
Added readme template and social links to the homepage
Browse files Browse the repository at this point in the history
  • Loading branch information
Praneeth Kolanu committed Jul 9, 2021
1 parent f91b5bb commit 66bd442
Show file tree
Hide file tree
Showing 13 changed files with 163 additions and 21 deletions.
137 changes: 136 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,136 @@
# cvGenerator
<p align="center">
<img width="100px" src="./img/readme/project_logo.png" align="center" alt="GitHub Readme Stats" />
<h2 align="center">CV Generator</h2>
<p align="center">Build your cv instantly on the go!</p>
</p>

<p align="center">
<a href="https://praneeth-rdy.github.io/cvGenerator">
<img src="https://img.shields.io/website?down_color=lightgrey&down_message=down&up_color=%231e90ff&up_message=live&url=https%3A%2F%2Fpraneeth-rdy.github.io%2F/cvGenerator%2F"/>
</a>
<a href="https://github.com/praneeth-rdy/cvGenerator/issues">
<img alt="Issues" src="https://img.shields.io/github/issues/praneeth-rdy/cvGenerator?color=0088ff" />
</a>
<a href="https://github.com/praneeth-rdy/cvGenerator/pulls">
<img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/praneeth-rdy/cvGenerator?color=0088ff" />
</a>
</p>

<!-- TABLE OF CONTENTS -->
<details open="open">
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<!-- <ul>
<li><a href="#built-with">Built With</a></li>
</ul> -->
</li>
<li>
<a href="#getting-started">Getting Started</a>
</li>
<li><a href="#usage">Usage</a></li>
<li>
<a href="#contributing">Contributing</a>
<ul>
<li>
<a href="#creating-a-pull-request">Creating a Pull Request</a>
</li>
<li>
<a href="#creating-an-issue">Creating an Issue</a>
</li>
</ul>
</li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgements">Acknowledgements</a></li>
</ol>
</details>



<!-- ABOUT THE PROJECT -->
## About The Project

[![Product Name Screen Shot][product-screenshot]](https://example.com)

There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.

Here's why:
* Your time should be focused on creating something amazing. A project that solves a problem and helps others
* You shouldn't be doing the same tasks over and over like creating a README from scratch
* You should element DRY principles to the rest of your life :smile:

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have have contributed to expanding this template!

A list of commonly used resources that I find helpful are listed in the acknowledgements.

### Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
* [Bootstrap](https://getbootstrap.com)
* [JQuery](https://jquery.com)
* [Laravel](https://laravel.com)



<!-- GETTING STARTED -->
## Getting Started

This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.

[product-screenshot]: readme-images/screenshot.png


<!-- USAGE EXAMPLES -->
## Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

_For more examples, please refer to the [Documentation](https://example.com)_


<!-- CONTRIBUTING -->
## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

### Creating a Pull Request

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request with the template given [here](pull_request_template.md)

### Creating an Issue

1. Go to the issues tab and check if there's any existing issue.
2. If there's no existing issue, create an issue using [this](issue_template.md) template.


<!-- LICENSE -->
## License

Distributed under the GPL License. See `LICENSE` for more information.



<!-- CONTACT -->
## Contact

Praneeth Reddy Kolanu - [@praneeth-rdy](https://www.facebook.com/praneeth.reddy.3557440) - [email protected]

Project Link: [https://github.com/praneeth-rdy/cvGenerator](https://github.com/praneeth-rdy/cvGenerator)


<!-- ACKNOWLEDGEMENTS -->
## Acknowledgements
* [GitHub Pages](https://pages.github.com)
* [Font Awesome](https://fontawesome.com)
* [Img Shields](https://shields.io)
* [Choose an Open Source License](https://choosealicense.com)



5 changes: 0 additions & 5 deletions global.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,6 @@ $('#editCv').on('click', (event) => {
cv.setAttribute('contenteditable', 'true');
});

$('#saveCv').on('click', (event) => {
cv.removeAttribute('contenteditable');
localStorage.setItem('cvData', JSON.stringify(cv.innerHTML));
});

$('#printCv').on('click', (event) => {
cv.classList.add('cv-to-print');
window.print();
Expand Down
2 changes: 1 addition & 1 deletion iitb/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
<div id="cv" class="iitb-cv-container cv-container">
<div class="header">
<div class="logo-container">
<img src="../logo/kgp-logo.png" />
<img src="../img/logo/kgp-logo.png" />
</div>
<div class="intro-block">
<h1 class="intro-text">Shekar Kammula</h1>
Expand Down
7 changes: 5 additions & 2 deletions iitb/main.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

let cv = document.getElementById('cv');

function initCv() {
cvData = JSON.parse(localStorage.getItem('iitbCvData'));
if(cvData){
Expand All @@ -10,6 +8,11 @@ function initCv() {

initCv();

$('#saveCv').on('click', (event) => {
cv.removeAttribute('contenteditable');
localStorage.setItem('iitbCvData', JSON.stringify(cv.innerHTML));
});

$('#resetCv').on('click', (event) => {
localStorage.removeItem('iitbCvData');
location.reload();
Expand Down
2 changes: 1 addition & 1 deletion iitkgp/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
<div id="cv" class="iitkgp-cv-container cv-container">
<div class="header">
<div>
<img src="../logo/kgp-logo.png" />
<img src="../img/logo/kgp-logo.png" />
</div>
<div>
<h1><span class="name">Shekar Kammula</span> | <span class="roll">19AZ10017</span></h1>
Expand Down
7 changes: 5 additions & 2 deletions iitkgp/main.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

let cv = document.getElementById('cv');

function initCv() {
cvData = JSON.parse(localStorage.getItem('iitkgpCvData'));
if(cvData){
Expand All @@ -10,6 +8,11 @@ function initCv() {

initCv();

$('#saveCv').on('click', (event) => {
cv.removeAttribute('contenteditable');
localStorage.setItem('iitkgpCvData', JSON.stringify(cv.innerHTML));
});

$('#resetCv').on('click', (event) => {
localStorage.removeItem('iitkgpCvData');
location.reload();
Expand Down
2 changes: 1 addition & 1 deletion iitm/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ <h1><span class="name">Shekar Kammula</span> | <span class="roll">CS18B023</span
<h2 class="campus">Indian Institute of Technology Madras</h2>
</div>
<div>
<img src="../logo/kgp-logo.png" />
<img src="../img/logo/kgp-logo.png" />
</div>
</div>
<div class="education">
Expand Down
7 changes: 5 additions & 2 deletions iitm/main.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

let cv = document.getElementById('cv');

function initCv() {
cvData = JSON.parse(localStorage.getItem('iitmCvData'));
if(cvData){
Expand All @@ -10,6 +8,11 @@ function initCv() {

initCv();

$('#saveCv').on('click', (event) => {
cv.removeAttribute('contenteditable');
localStorage.setItem('iitmCvData', JSON.stringify(cv.innerHTML));
});

$('#resetCv').on('click', (event) => {
localStorage.removeItem('iitmCvData');
location.reload();
Expand Down
File renamed without changes
File renamed without changes
Binary file added img/readme/project_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,16 +109,16 @@ <h1 class="section-heading">Contribute your part, by filling this feedback form<
<div class="footer d-flex flex-column text-center mt-4">
<div>Made with <i class="fa fa-heart"></i> by <a href="https://github.com/Praneeth-rdy">praneeth-rdy</a></div>
<div class="social-icons-container my-3">
<a href="">
<a href="https://www.facebook.com/praneeth.reddy.3557440">
<i class="fab fa-facebook"></i>
</a>
<a href="">
<a href="https://www.instagram.com/praneeth__rdy/">
<i class="fab fa-instagram"></i>
</a>
<a href="">
<a href="https://www.linkedin.com/in/praneeth-/">
<i class="fab fa-linkedin"></i>
</a>
<a href="">
<a href="mailto:[email protected]">
<i class="fa fa-envelope"></i>
</a>
</div>
Expand Down
7 changes: 5 additions & 2 deletions template/main.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

let cv = document.getElementById('cv');

function initCv() {
cvData = JSON.parse(localStorage.getItem('clgnameCvData'));
if(cvData){
Expand All @@ -10,6 +8,11 @@ function initCv() {

initCv();

$('#saveCv').on('click', (event) => {
cv.removeAttribute('contenteditable');
localStorage.setItem('clgnameCvData', JSON.stringify(cv.innerHTML));
});

$('#resetCv').on('click', (event) => {
localStorage.removeItem('clgnameCvData');
location.reload();
Expand Down

0 comments on commit 66bd442

Please sign in to comment.