Skip to content

Commit d25c04e

Browse files
Finalizing documents
1 parent 727f0df commit d25c04e

File tree

2 files changed

+17
-16
lines changed

2 files changed

+17
-16
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ If you are contributing to the Open Source for the first time, You can check out
33

44
# Local Setup
55

6-
- [Fork](https://github.com/Pika1998/Meetup-Widget/fork) the respository.
7-
- Clone your forked copy of the repository using `git clone https://github.com/${yourUsername}/Meetup-Widget`
8-
- `cd Meetup-Widget`
6+
- [Fork](https://github.com/Pika1998/Git-Widget/fork) the respository.
7+
- Clone your forked copy of the repository using `git clone https://github.com/${yourUsername}/Git-Widget`
8+
- `cd Git-Widget`
99
- `npm install` to install the dev dependencies.
10-
- `npm run meetup-widget` will get the server running.
10+
- `npm run git-widget` will get the server running.
1111

1212

1313
# File Structure
@@ -30,8 +30,8 @@ The code is based upon web components and does not use any dependency. You can r
3030
- If you are looking to add CSS then checkout `card.style.mjs`
3131

3232
# First-time Contributors Guide
33-
- You can checkout the [Issues](https://github.com/Pika1998/Meetup-Widget/issues) and select the one that you like (You can comment on issue to let me know that you're working on it.)
33+
- You can checkout the [Issues](https://github.com/Pika1998/Git-Widget/issues) and select the one that you like (You can comment on issue to let me know that you're working on it.)
3434
- Just go through the [Local Setup Guide](#local-setup) to locally setup the project
35-
- Once you are done making changes you can create a Pull Request to the master of this (https://github.com/Pika1998/Meetup-Widget) repository.
35+
- Once you are done making changes you can create a Pull Request to the master of this (https://github.com/Pika1998/Git-Widget) repository.
3636

3737

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
1-
# Meetup Widget
1+
# Git Widget
22

3-
Codepen - https://codepen.io/Prafulla1998/pen/OJVNzxP
43

5-
Unofficial Widget to showcase the events which you have organized on meetup.com 📅
4+
### Showcase your projects on their official websites/blogs.
5+
6+
### A Detailed timeline of contributions done on your project.
67

78

89

910
[![Screenshot of the Meetup Widget](https://res.cloudinary.com/prafulla98/image/upload/v1582385089/Meetup-Widget/ss_2_mymjm6.png?style=center)](#installation-and-usage)
1011

1112
# Installation & Usage
1213

13-
You can install meetup-widget using two ways.
14+
You can install git-widget using two ways.
1415

1516
## 1 - Using Script
1617

1718
```html
18-
<meetup-widget data-groupurl="Mumbai-Flutter"></meetup-widget>
19+
<git-widget data-projectid="Pika1998/CYOMS"></git-widget>
1920
<!-- Place script tag before the end of the body tag -->
2021
<script src="" type="module"></script>
2122
```
@@ -24,19 +25,19 @@ You can install meetup-widget using two ways.
2425

2526
This can be used in React, Vue and almost any other frontend framework
2627
```sh
27-
npm install --save meetup-widget
28+
npm install --save git-widget
2829
```
2930

3031
Inside your framework component
3132
```js
32-
import 'meetup-widget'
33+
import 'git-widget'
3334
```
3435

3536
# Attributes
3637

3738
| attributes | description | default |
3839
|---------------|-------------------------------|--------------------------|
39-
| data-groupname | Your meetup.com Username | |
40-
| data-width | Width of the card | 350px |
40+
| data-projectid | < Your Github UserID > / < Project you want to showcase> | |
41+
| data-width | Width of the card | 400px |
4142
| data-height | Height of the card | 500px
42-
| data-mode | Set this to **production** while deploying in a realtime environment |
43+

0 commit comments

Comments
 (0)