You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Please feel free to take on any issue that's currently open. Just send a comment
16
16
17
17
## Submitting a pull request
18
18
19
-
**@afc/svelte-tailwind** is an open-source project, so pull requests are always welcomed (_always_ ❤️).
19
+
**@afc-org/svelte-tailwind** is an open-source project, so pull requests are always welcomed (_always_ ❤️).
20
20
What we ask you, is that before working on a large change, it is best to open an issue first to discuss it with the maintainers or if an issue was already opened, comment your intention of opening up a PR.
21
21
22
22
When in doubt, keep your pull requests small. To give a PR the best chance of getting accepted, don't bundle more than one feature or bug fix per pull request. It's always best to create two smaller PRs than one big one.
@@ -78,5 +78,5 @@ Closes #12
78
78
## Branches explained
79
79
80
80
As you can see we have multiple branches:
81
-
-**master**: This branch stores the latest stable version of @afc/svelte-tailwind.
82
-
-**dev-master**: This is the **development** branch of @afc/svelte-tailwind, and this is where everything is happening before releasing on master
81
+
-**master**: This branch stores the latest stable version of @afc-org/svelte-tailwind.
82
+
-**dev-master**: This is the **development** branch of @afc-org/svelte-tailwind, and this is where everything is happening before releasing on master
**@afc/svelte-tailwind** is Free and Open Source. It does not change or add any CSS to the already one from TailwindCSS, It comes with code written with Svelte as an extension to TailwindCSS for you to have dynamic components inside your app as well.
9
+
**@afc-org/svelte-tailwind** is Free and Open Source. It does not change or add any CSS to the already one from TailwindCSS, It comes with code written with Svelte as an extension to TailwindCSS for you to have dynamic components inside your app as well.
10
10
11
11
### Components
12
12
@@ -46,12 +46,12 @@ We plan on implementing more, in the weeks to come.
46
46
## Quick start
47
47
48
48
```
49
-
npm i -E @afc/svelte-tailwind
49
+
npm i -E @afc-org/svelte-tailwind
50
50
```
51
51
52
52
## Documentation - Svelte
53
53
54
-
After you have installed `@afc/svelte-tailwind` into your project, you can import and use our components like so:
54
+
After you have installed `@afc-org/svelte-tailwind` into your project, you can import and use our components like so:
55
55
56
56
```
57
57
@@ -75,7 +75,7 @@ Then, you can import your styles inside your `index.js` file (mounting js file f
75
75
76
76
## Dependencies
77
77
78
-
**@afc/svelte-tailwind** to properly work needs the following dependencies:
78
+
**@afc-org/svelte-tailwind** to properly work needs the following dependencies:
79
79
-**@popperjs/core**@2.2.1
80
80
-**svelte**@3.20.1
81
81
```
@@ -94,7 +94,7 @@ At present, we officially aim to support the last two versions of the following
94
94
95
95
We use GitHub Issues as the official bug tracker for the Angular Landing Page. Here are some advices for our users that want to report an issue:
96
96
97
-
1. Make sure that you are using the latest version of the @afc/svelte-tailwind.
97
+
1. Make sure that you are using the latest version of the @afc-org/svelte-tailwind.
98
98
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
99
99
3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.
100
100
@@ -103,7 +103,7 @@ This project exists thanks to all the people who contribute. [[Contribute](CONTR
103
103
104
104
## Licensing
105
105
106
-
- Copyright 2020 @afc/svelte-tailwind
106
+
- Copyright 2020 @afc-org/svelte-tailwind
107
107
108
108
- Licensed under <ahref="https://github.com/afc-org/svelte-tailwind/blob/master/LICENSE.md"target="_blank">MIT</a>
0 commit comments