Skip to content

Commit d397e9b

Browse files
committed
docs: change afc to afc-org
1 parent b237c75 commit d397e9b

File tree

3 files changed

+35
-28
lines changed

3 files changed

+35
-28
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Please feel free to take on any issue that's currently open. Just send a comment
1616

1717
## Submitting a pull request
1818

19-
**@afc/react-tailwind** is an open-source project, so pull requests are always welcomed (_always_ ❤️).
19+
**@afc-org/react-tailwind** is an open-source project, so pull requests are always welcomed (_always_ ❤️).
2020
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.
2121

2222
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
7878
## Branches explained
7979

8080
As you can see we have multiple branches:
81-
- **master**: This branch stores the latest stable version of @afc/react-tailwind.
82-
- **dev-master**: This is the **development** branch of @afc/react-tailwind, and this is where everything is happening before releasing on master
81+
- **master**: This branch stores the latest stable version of @afc-org/react-tailwind.
82+
- **dev-master**: This is the **development** branch of @afc-org/react-tailwind, and this is where everything is happening before releasing on master

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# @afc/react-tailwind
1+
# @afc-org/react-tailwind
22

3-
![version](https://img.shields.io/badge/version-0.1.0-blue.svg) ![license](https://img.shields.io/badge/license-MIT-blue.svg) <a href="https://github.com/afc-org/react-tailwind/issues?q=is%3Aopen+is%3Aissue" target="_blank">![GitHub issues open](https://img.shields.io/github/issues/@afc/react-tailwind.svg)</a> <a href="https://github.com/afc-org/react-tailwind?q=is%3Aissue+is%3Aclosed" target="_blank">![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/@afc/react-tailwind.svg)</a>
3+
![version](https://img.shields.io/badge/version-0.1.0-blue.svg) ![license](https://img.shields.io/badge/license-MIT-blue.svg) <a href="https://github.com/afc-org/react-tailwind/issues?q=is%3Aopen+is%3Aissue" target="_blank">![GitHub issues open](https://img.shields.io/github/issues/@afc-org/react-tailwind.svg)</a> <a href="https://github.com/afc-org/react-tailwind?q=is%3Aissue+is%3Aclosed" target="_blank">![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/@afc-org/react-tailwind.svg)</a>
44

5-
<div align="center"><img src="./assets/logos/reactjs-tailwind-logo.png" alt="@afc/react-tailwind" width="300"/></div>
5+
<div align="center"><img src="./assets/logos/reactjs-tailwind-logo.png" alt="@afc-org/react-tailwind" width="300"/></div>
66

77
### A dynamic plugin extension for TailwindCSS.
88

9-
@afc/react-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 React as an extension to TailwindCSS for you to have dynamic components inside your app as well.
9+
@afc-org/react-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 React as an extension to TailwindCSS for you to have dynamic components inside your app as well.
1010

1111
**Components**
1212

@@ -47,12 +47,12 @@ We plan on implementing more, in the weeks to come.
4747
## Quick start
4848

4949
```
50-
npm i -E @afc/react-tailwind
50+
npm i -E @afc-org/react-tailwind
5151
```
5252

5353
## Documentation - React
5454

55-
After you have installed `@afc/react-tailwind` into your project, you can import and use our components like so:
55+
After you have installed `@afc-org/react-tailwind` into your project, you can import and use our components like so:
5656

5757
### Alert
5858

@@ -62,9 +62,9 @@ Usage:
6262
// with closing button
6363
6464
import React from "react";
65-
import { Alert } from "@afc/react-tailwind";
65+
import { Alert } from "@afc-org/react-tailwind";
6666
// or direct import
67-
// import Alert from "@afc/react-tailwind/Alert";
67+
// import Alert from "@afc-org/react-tailwind/Alert";
6868
6969
// With Function Components (hooks)
7070
export default function YourFunctionName() {
@@ -92,9 +92,9 @@ export default function YourFunctionName() {
9292
// this means, that you can controll whether the Alert is shown or not
9393
9494
import React from "react";
95-
import { Alert } from "@afc/react-tailwind";
95+
import { Alert } from "@afc-org/react-tailwind";
9696
// or direct import
97-
// import Alert from "@afc/react-tailwind/src/Alert";
97+
// import Alert from "@afc-org/react-tailwind/src/Alert";
9898
9999
// With Function Components (hooks)
100100
export default function YourFunctionName() {
@@ -159,7 +159,7 @@ Usage:
159159

160160
```
161161
import React from "react";
162-
import { Button } from "@afc/react-tailwind";
162+
import { Button } from "@afc-org/react-tailwind";
163163
164164
// With Function Components (hooks)
165165
export default function YourFunctionName() {
@@ -210,7 +210,7 @@ import {
210210
DropdownToggle,
211211
DropdownMenu,
212212
DropdownItem
213-
} from "@afc/react-tailwind";
213+
} from "@afc-org/react-tailwind";
214214
215215
const YourComponent = () => {
216216
return (
@@ -237,7 +237,7 @@ import {
237237
DropdownToggle,
238238
DropdownMenu,
239239
DropdownItem
240-
} from "@afc/react-tailwind";
240+
} from "@afc-org/react-tailwind";
241241
242242
const YourComponent = () => {
243243
const [show,setShow] = React.useState(false);
@@ -371,7 +371,7 @@ import {
371371
ModalFooter,
372372
ModalHead,
373373
ModalTitle
374-
} from "@afc/react-tailwind";
374+
} from "@afc-org/react-tailwind";
375375
376376
const YourComponent = () => {
377377
const [show, setShow] = React.useState(false);
@@ -498,7 +498,7 @@ import {
498498
NavbarLink,
499499
NavbarNav,
500500
NavbarToggler
501-
} from "@afc/react-tailwind";
501+
} from "@afc-org/react-tailwind";
502502
503503
const YourComponent = () => {
504504
return (
@@ -541,7 +541,7 @@ import {
541541
NavbarLink,
542542
NavbarNav,
543543
NavbarToggler
544-
} from "@afc/react-tailwind";
544+
} from "@afc-org/react-tailwind";
545545
546546
const YourComponent = () => {
547547
const [show, setShow] = React.useState(false);
@@ -690,7 +690,7 @@ Usage:
690690
```
691691
// controlled usage
692692
import React from "react";
693-
import { Button, Popover, PopoverHead, PopoverBody } from "@afc/react-tailwind";
693+
import { Button, Popover, PopoverHead, PopoverBody } from "@afc-org/react-tailwind";
694694
695695
const YourComponent = () => {
696696
const [show, setShow] = React.useState(false);
@@ -778,7 +778,7 @@ Usage:
778778
```
779779
// controlled usage
780780
import React from "react";
781-
import { Button, Tooltip } from "@afc/react-tailwind";
781+
import { Button, Tooltip } from "@afc-org/react-tailwind";
782782
783783
const YourComponent = () => {
784784
const [show, setShow] = React.useState(false);
@@ -849,7 +849,7 @@ Usage:
849849
```
850850
// uncontrolled version
851851
import React from "react";
852-
import { TabContainer, TabItem, TabLink, TabContent } from "@afc/react-tailwind";
852+
import { TabContainer, TabItem, TabLink, TabContent } from "@afc-org/react-tailwind";
853853
854854
const YourComponent = () => {
855855
return (
@@ -928,7 +928,7 @@ export default YourComponent;
928928
// of each tab-link individualy, the color from the tab-container
929929
// will no longer be applied :(
930930
import React from "react";
931-
import { TabContainer, TabItem, TabLink, TabContent } from "@afc/react-tailwind";
931+
import { TabContainer, TabItem, TabLink, TabContent } from "@afc-org/react-tailwind";
932932
933933
const YourComponent = () => {
934934
const [active, setActive] = React.useState("tab-id-2");
@@ -1128,7 +1128,7 @@ import "path/to/your/tailwindcss/compiled/styles.css";
11281128

11291129
## Dependencies
11301130

1131-
**@afc/react-tailwind** to properly work needs the following dependencies:
1131+
**@afc-org/react-tailwind** to properly work needs the following dependencies:
11321132
- **@popperjs/core**@2.2.1
11331133
- **react**@16.13.1
11341134
- **react-dom**@16.13.1
@@ -1148,7 +1148,7 @@ At present, we officially aim to support the last two versions of the following
11481148

11491149
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:
11501150

1151-
1. Make sure that you are using the latest version of the @afc/react-tailwind.
1151+
1. Make sure that you are using the latest version of the @afc-org/react-tailwind.
11521152
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
11531153
3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.
11541154

@@ -1158,7 +1158,7 @@ This project exists thanks to all the people who contribute. [[Contribute](CONTR
11581158

11591159
## Licensing
11601160

1161-
- Copyright 2020 @afc/react-tailwind
1161+
- Copyright 2020 @afc-org/react-tailwind
11621162

11631163
- Licensed under <a href="https://github.com/afc-org/react-tailwind/blob/master/LICENSE.md" target="_blank">MIT</a>
11641164

package.json

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@afc/react-tailwind",
2+
"name": "@afc-org/react-tailwind",
33
"version": "0.1.0",
44
"description": "Dynamic components for Tailwindcss and ReactJS",
55
"main": "./src/index.js",
@@ -25,7 +25,7 @@
2525
"tailwindjs",
2626
"afc-org",
2727
"afc",
28-
"@afc"
28+
"@afc-org"
2929
],
3030
"author": "afc-org",
3131
"license": "MIT",
@@ -39,5 +39,12 @@
3939
"prop-types": "15.7.x",
4040
"react": "16.13.x",
4141
"tailwindcss": "1.2.x"
42+
},
43+
"dependencies": {
44+
"@popperjs/core": "2.3.3",
45+
"classnames": "2.2.6",
46+
"prop-types": "15.7.2",
47+
"react": "16.13.1",
48+
"tailwindcss": "1.3.3"
4249
}
4350
}

0 commit comments

Comments
 (0)