diff --git a/.all-contributorsrc b/.all-contributorsrc
new file mode 100644
index 0000000..3f78cce
--- /dev/null
+++ b/.all-contributorsrc
@@ -0,0 +1,33 @@
+{
+ "files": [
+ "README.md"
+ ],
+ "imageSize": 100,
+ "commit": false,
+ "contributors": [
+ {
+ "login": "navu9999",
+ "name": "Navpreet Kaur",
+ "avatar_url": "https://avatars1.githubusercontent.com/u/59786562?v=4",
+ "profile": "https://www.linkedin.com/in/navpreet-kaur24/",
+ "contributions": [
+ "doc"
+ ]
+ },
+ {
+ "login": "maze-runnar",
+ "name": "Sundaram Dubey",
+ "avatar_url": "https://avatars2.githubusercontent.com/u/56407566?v=4",
+ "profile": "https://sundaram-dubey.netlify.app/",
+ "contributions": [
+ "code"
+ ]
+ }
+ ],
+ "contributorsPerLine": 7,
+ "projectName": "profext",
+ "projectOwner": "garimasingh128",
+ "repoType": "github",
+ "repoHost": "https://github.com",
+ "skipCi": true
+}
diff --git a/README.md b/README.md
index 26dc89e..0429069 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,7 @@
+
+[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
+
# This project is a part of Student Code In 2020 👣
OPEN SOURCE CONTEST - STUDENT CODE IN
@@ -13,7 +16,7 @@
-[Check out the website of Student Code In 2020](https://scodein.tech/)
+⭐ [Check out the website of Student Code In 2020](https://scodein.tech/)
# 👣 Profile Extension
@@ -32,6 +35,33 @@
A profile 🔎 search engine for accessing my all social media profile in one tap.👨💻👩. This chrome extension let's you track your profiles on any account in a single click.
+## 📋 Table of Contents
+ ➡️ [Vision](#-vision)
+
+ ➡️ [Project Structure](#-project-structure)
+
+ ➡️ [Tech Stack](#-tech-stack)
+
+ ➡️ [Setup Development Environment](#-steps-to-setup-development-environment)
+
+ ➡️ [Development Guidelines](#-development-guidelines)
+
+ ➡️ [Learning Resources](#-learning-resources)
+
+ ➡️ [Simple things to keep in mind](#-simple-things-to-keep-in-mind)
+
+
+
+ ➡️ [System Requirements](#-system-requirements)
+
+ ➡️ [Contributing](#-contributing)
+
+ ➡️ [Owner](#-owner)
+
+
+
+
+
## 👩 Vision
Getting all your social media profiles under one button click so that you don't have to manually search and do the hassle of searching your profile handles while making your resume, filling job opportunities forms, registering for events etc.
@@ -48,6 +78,12 @@ This is motivated by [Traversy Media tutorial on Google Chrome Extention](https:
|── popup.js
|── README
└── ...
+
+## 🔆 Tech Stack
+- HTML
+- CSS
+- JavaScript
+
## 🚀 Steps to setup development environment
1. Clone the repo
@@ -57,7 +93,7 @@ This is motivated by [Traversy Media tutorial on Google Chrome Extention](https:
2. Open the folder in your favourite code editor and start adding modifications.
3. Load the folder in `chrome://extensions/` on chrome (Load unpacked)
- ## 💻 Development guidelines
+ ## 💻 Development guidelines
1. Put all the code in one of the existing files in `/src` . If you add a new file, make a relavent modification to `build.js` .
@@ -67,11 +103,15 @@ This is motivated by [Traversy Media tutorial on Google Chrome Extention](https:
5. Load the `/build` folder in `chrome://extensions/` on chrome (Load unpacked)
-## ⏪ Getting Started
+## 📝 Learning Resources
Read these articles to get a quick grab on making Chrome extensions:
- [Google Chrome official docs](https://developer.chrome.com/extensions)
- [Free Code Camp's article on # How to Create and Publish a Chrome Extension in 20 minutes](https://www.freecodecamp.org/news/how-to-create-and-publish-a-chrome-extension-in-20-minutes-6dc8395d7153/)
+
+Resources to learn Git:
+- https://try.github.io/
+
## 🧐 Simple things to keep in mind
- The first step is to create a manifest file named `manifest.json`. This is a metadata file in JSON format that contains properties like your extension’s name, description, version number and so on. In this file we tell Chrome what the extension is going to do, and what permissions it requires.
- To test if the extension works, visit `chrome://extensions` in your browser and ensure that the **Developer mode** checkbox in the top right-hand corner is checked.
@@ -79,10 +119,15 @@ Read these articles to get a quick grab on making Chrome extensions:
- When your first Chrome extension looks nice and works like it should, it’s time to publish it to the Chrome Store. Simply follow [this link](https://chrome.google.com/webstore/developer/dashboard) to go to your Chrome Web Store dashboard (you’ll be asked to sign in to your Google account if you’re not). Then click the `**Add new item**` button, accept the terms and you will go to the page where you can upload your extension. Now compress the folder that contains your project and upload that ZIP file.
- As a web developer, it’s very easy to create a Chrome extension in a short amount of time. All you need is some HTML, CSS, JavaScript and a basic knowledge of how to add functionality through some of the JavaScript APIs that Chrome exposes. Your initial setup can be published inside the Chrome Web Store within just 20 minutes. Building an extension that’s new, worthwhile or looks nice will take some more time. But it’s all up to you!
+## 💻 System Requirements
+- Google Chrome
+- Git
+- Code Editor (Visual Studio Code,Sublime Text)
+
## 🏆 Contributing
Please read CONTRIBUTING.md for information on how to contribute to profext-extension.
-## 👬 Owner
+## 👬 Owner
[Garima Singh](https://github.com/garimasingh128)
@@ -92,3 +137,23 @@ Please read CONTRIBUTING.md for information on how to contribute to profext-ex
[![built with love](https://forthebadge.com/images/badges/built-with-love.svg)](https://github.com/garimasingh128/)
## ❤️ Thanks to our awesome contributors.
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+
+
+
+