Merge pull request #16 from creativetimofficial/docs/add-assets

Docs: add assets

Author: einazare

CODE_OF_CONDUCT.md

@@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at tailwindjs@gmail.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at allframeworkscomponents@gmail.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
 

CONTRIBUTING.md

@@ -6,7 +6,7 @@ Even if you have little to no experience with Tailwindcss, JavaScript or React,
 
 ## Reporting issues & features requests
 
-If you notice any bugs in the code, see some code that can be improved, or have features you would like to be added, please create a [bug report](https://github.com/tailwindjs/react-tailwindjs/issues/new?template=bug-report---.md) or a [feature request](https://github.com/tailwindjs/react-tailwindjs/issues/new?template=feature-request---.md)!
+If you notice any bugs in the code, see some code that can be improved, or have features you would like to be added, please create a [bug report](https://github.com/afc-org/react-tailwind/issues/new?template=bug-report---.md) or a [feature request](https://github.com/afc-org/react-tailwind/issues/new?template=feature-request---.md)!
 
 If you want to open a PR that fixes a bug or adds a feature, then we can't thank you enough!
 
@@ -16,7 +16,7 @@ Please feel free to take on any issue that's currently open. Just send a comment
 
 ## Submitting a pull request
 
-Tailwindjs/react-tailwindjs is an open-source project, so pull requests are always welcomed (_always_ ❤️).
+**@afc/react-tailwind** is an open-source project, so pull requests are always welcomed (_always_ ❤️).
 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.
 
 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
 ## Branches explained
 
 As you can see we have multiple branches:
- - **master**: This branch stores the latest stable version of tailwindjs/react-tailwindjs.
- - **dev-master**: This is the **development** branch of tailwindjs/react-tailwindjs, and this is where everything is happening before releasing on master
+ - **master**: This branch stores the latest stable version of @afc/react-tailwind.
+ - **dev-master**: This is the **development** branch of @afc/react-tailwind, and this is where everything is happening before releasing on master

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 https://github.com/tailwindjs/react-tailwindjs
+Copyright (c) 2020 https://github.com/afc-org/react-tailwind
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,12 +1,12 @@
-# Tailwindjs/react-tailwindjs
+# @afc/react-tailwind
 
-![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/tailwindjs/react-tailwindjs/issues?q=is%3Aopen+is%3Aissue" target="_blank">![GitHub issues open](https://img.shields.io/github/issues/tailwindjs/react-tailwindjs.svg)</a> <a href="https://github.com/tailwindjs/react-tailwindjs?q=is%3Aissue+is%3Aclosed" target="_blank">![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/tailwindjs/react-tailwindjs.svg)</a>
+![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>
 
-![tailwindjs/react-tailwindjs]({{--logo-image-here--}})
+<div align="center"><img src="./assets/logos/reactjs-tailwind-logo.png" alt="@afc/react-tailwind" width="300"/></div>
 
 ### A dynamic plugin extension for TailwindCSS.
 
-Tailwindjs/react-tailwindjs 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.
+@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.
 
 **Components**
 
@@ -28,9 +28,9 @@ We plan on implementing more, in the weeks to come.
 
 ## Versions
 
-|Angular|JavaScript|React|VueJS|Svelte|
+|Angular|JavaScript|React|Svelte|VueJS|
 | --- | --- | --- | --- | --- |
-| <a href="https://github.com/tailwindjs/angular-tailwindjs" target="_blank">Check Angular</a>  | <a href="https://github.com/tailwindjs/tailwindjs" target="_blank">Check JavaScript</a>  | <a href="https://github.com/tailwindjs/react-tailwindjs" target="_blank">Check React</a>  | <a href="https://github.com/tailwindjs/vue-tailwindjs" target="_blank">Check VueJS</a>  | <a href="https://github.com/tailwindjs/svelte-tailwindjs" target="_blank">Check Svelte</a>  |
+| <a href="https://github.com/afc-org/angular-tailwind" target="_blank">![Check Angular](./assets/logos/angular-tailwind-logo.png)</a>  | <a href="https://github.com/afc-org/js-tailwind" target="_blank">![Check JavaScript](./assets/logos/javascript-tailwind-logo.png)</a>  | <a href="https://github.com/afc-org/react-tailwind" target="_blank">![Check React](./assets/logos/reactjs-tailwind-logo.png)</a>  | <a href="https://github.com/afc-org/svelte-tailwind" target="_blank">![Check Svelte](./assets/logos/svelte-tailwind-logo.png)</a>    | <a href="https://github.com/afc-org/vue-tailwind" target="_blank">![Check VueJS](./assets/logos/vuejs-tailwind-logo.png)</a>|
 
 ## Components
 
@@ -47,12 +47,12 @@ We plan on implementing more, in the weeks to come.
 ## Quick start
 
 ```
-npm i -E @tailwindjs/react-tailwindjs
+npm i -E @afc/react-tailwind
 ```
 
 ## Documentation - React
 
-After you have installed `@tailwindjs/react-tailwindjs` into your project, you can import and use our components like so:
+After you have installed `@afc/react-tailwind` into your project, you can import and use our components like so:
 
 ### Alert
 
@@ -62,9 +62,9 @@ Usage:
 // with closing button
 
 import React from "react";
-import { Alert } from "@tailwindjs/react-tailwindjs";
+import { Alert } from "@afc/react-tailwind";
 // or direct import
-// import Alert from "@tailwindjs/react-tailwindjs/Alert";
+// import Alert from "@afc/react-tailwind/Alert";
 
 // With Function Components (hooks)
 export default function YourFunctionName() {
@@ -92,9 +92,9 @@ export default function YourFunctionName() {
 // this means, that you can controll whether the Alert is shown or not
 
 import React from "react";
-import { Alert } from "@tailwindjs/react-tailwindjs";
+import { Alert } from "@afc/react-tailwind";
 // or direct import
-// import Alert from "@tailwindjs/react-tailwindjs/src/Alert";
+// import Alert from "@afc/react-tailwind/src/Alert";
 
 // With Function Components (hooks)
 export default function YourFunctionName() {
@@ -159,7 +159,7 @@ Usage:
 
 ```
 import React from "react";
-import { Button } from "@tailwindjs/react-tailwindjs";
+import { Button } from "@afc/react-tailwind";
 
 // With Function Components (hooks)
 export default function YourFunctionName() {
@@ -210,7 +210,7 @@ import {
   DropdownToggle,
   DropdownMenu,
   DropdownItem
-} from "@tailwindjs/react-tailwindjs";
+} from "@afc/react-tailwind";
 
 const YourComponent = () => {
   return (
@@ -237,7 +237,7 @@ import {
   DropdownToggle,
   DropdownMenu,
   DropdownItem
-} from "@tailwindjs/react-tailwindjs";
+} from "@afc/react-tailwind";
 
 const YourComponent = () => {
   const [show,setShow] = React.useState(false);
@@ -371,7 +371,7 @@ import {
   ModalFooter,
   ModalHead,
   ModalTitle
-} from "@tailwindjs/react-tailwindjs";
+} from "@afc/react-tailwind";
 
 const YourComponent = () => {
   const [show, setShow] = React.useState(false);
@@ -498,7 +498,7 @@ import {
   NavbarLink,
   NavbarNav,
   NavbarToggler
-} from "@tailwindjs/react-tailwindjs";
+} from "@afc/react-tailwind";
 
 const YourComponent = () => {
   return (
@@ -541,7 +541,7 @@ import {
   NavbarLink,
   NavbarNav,
   NavbarToggler
-} from "@tailwindjs/react-tailwindjs";
+} from "@afc/react-tailwind";
 
 const YourComponent = () => {
   const [show, setShow] = React.useState(false);
@@ -690,7 +690,7 @@ Usage:
 ```
 // controlled usage
 import React from "react";
-import { Button, Popover, PopoverHead, PopoverBody } from "@tailwindjs/react-tailwindjs";
+import { Button, Popover, PopoverHead, PopoverBody } from "@afc/react-tailwind";
 
 const YourComponent = () => {
   const [show, setShow] = React.useState(false);
@@ -778,7 +778,7 @@ Usage:
 ```
 // controlled usage
 import React from "react";
-import { Button, Tooltip } from "@tailwindjs/react-tailwindjs";
+import { Button, Tooltip } from "@afc/react-tailwind";
 
 const YourComponent = () => {
   const [show, setShow] = React.useState(false);
@@ -849,7 +849,7 @@ Usage:
 ```
 // uncontrolled version
 import React from "react";
-import { TabContainer, TabItem, TabLink, TabContent } from "@tailwindjs/react-tailwindjs";
+import { TabContainer, TabItem, TabLink, TabContent } from "@afc/react-tailwind";
 
 const YourComponent = () => {
   return (
@@ -928,7 +928,7 @@ export default YourComponent;
 // of each tab-link individualy, the color from the tab-container
 // will no longer be applied :(
 import React from "react";
-import { TabContainer, TabItem, TabLink, TabContent } from "@tailwindjs/react-tailwindjs";
+import { TabContainer, TabItem, TabLink, TabContent } from "@afc/react-tailwind";
 
 const YourComponent = () => {
   const [active, setActive] = React.useState("tab-id-2");
@@ -1128,7 +1128,7 @@ import "path/to/your/tailwindcss/compiled/styles.css";
 
 ## Dependencies
 
-**@tailwindjs/react-tailwindjs** to properly work needs the following dependencies:
+**@afc/react-tailwind** to properly work needs the following dependencies:
 - **@popperjs/core**@2.2.1
 - **react**@16.13.1
 - **react-dom**@16.13.1
@@ -1142,31 +1142,31 @@ At present, we officially aim to support the last two versions of the following
 
 | Chrome | Firefox | Edge | Safari | Opera |
 |:---:|:---:|:---:|:---:|:---:|
-| <img src="https://github.com/tailwindjs/react-tailwindjs/blob/master/assets/logos/chrome-logo.png?raw=true" width="64" height="64"> | <img src="https://github.com/tailwindjs/react-tailwindjs/blob/master/assets/logos/firefox-logo.png?raw=true" width="64" height="64"> | <img src="https://github.com/tailwindjs/react-tailwindjs/blob/master/assets/logos/edge-logo.png?raw=true" width="64" height="64"> | <img src="https://github.com/tailwindjs/react-tailwindjs/blob/master/assets/logos/safari-logo.png?raw=true" width="64" height="64"> | <img src="https://github.com/tailwindjs/react-tailwindjs/blob/master/assets/logos/opera-logo.png?raw=true" width="64" height="64"> |
+| <img src="./assets/logos/chrome-logo.png" width="64" height="64"> | <img src="./assets/logos/firefox-logo.png" width="64" height="64"> | <img src="./assets/logos/edge-logo.png" width="64" height="64"> | <img src="./assets/logos/safari-logo.png" width="64" height="64"> | <img src="./assets/logos/opera-logo.png" width="64" height="64"> |
 
 ## Reporting Issues
 
 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:
 
-1. Make sure that you are using the latest version of the @tailwindjs/react-tailwindjs.
+1. Make sure that you are using the latest version of the @afc/react-tailwind.
 2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
 3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.
 
 ## Contributors
 This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
-<a href="https://github.com/tailwindjs/react-tailwindjs/contributors"><img src="https://opencollective.com/tailwindjs/contributors.svg?width=890&button=false" /></a>
+
 
 ## Licensing
 
-- Copyright 2020 Tailwindjs/react-tailwindjs
+- Copyright 2020 @afc/react-tailwind
 
-- Licensed under <a href="https://github.com/tailwindjs/react-tailwind/blob/master/LICENSE.md" target="_blank">MIT</a>
+- Licensed under <a href="https://github.com/afc-org/react-tailwind/blob/master/LICENSE.md" target="_blank">MIT</a>
 
 ## Resources
-- Tailwindjs projects: <a href="https://github.com/tailwindjs/" target="_blank">https://github.com/tailwindjs/</a>
-- JavaScript & TailwindCSS: <a href="https://github.com/tailwindjs/tailwindjs" target="_blank">https://github.com/tailwindjs/tailwindjs</a>
-- Angular & TailwindCSS: <a href="https://github.com/tailwindjs/angular-tailwindjs" target="_blank">https://github.com/tailwindjs/angular-tailwindjs</a>
-- React & TailwindCSS: <a href="https://github.com/tailwindjs/angular-tailwindjs" target="_blank">https://github.com/tailwindjs/react-tailwindjs</a>
-- Svelte & TailwindCSS: <a href="https://github.com/tailwindjs/angular-tailwindjs" target="_blank">https://github.com/tailwindjs/svelte-tailwindjs</a>
-- VueJS & TailwindCSS:  <a href="https://github.com/tailwindjs/angular-tailwindjs" target="_blank">https://github.com/tailwindjs/vue-tailwindjs</a>
-- Issues: <a href="https://github.com/tailwindjs/react-tailwindjs/issues" target="_blank">Github Issues Page</a>
+- AFC-ORG projects: <a href="https://github.com/afc-org/" target="_blank">https://github.com/afc-org/</a>
+- JavaScript & TailwindCSS: <a href="https://github.com/afc-org/js-tailwind" target="_blank">https://github.com/afc-org/js-tailwind</a>
+- Angular & TailwindCSS: <a href="https://github.com/afc-org/angular-tailwind" target="_blank">https://github.com/afc-org/angular-tailwind</a>
+- React & TailwindCSS: <a href="https://github.com/afc-org/angular-tailwind" target="_blank">https://github.com/afc-org/react-tailwind</a>
+- Svelte & TailwindCSS: <a href="https://github.com/afc-org/angular-tailwind" target="_blank">https://github.com/afc-org/svelte-tailwind</a>
+- VueJS & TailwindCSS:  <a href="https://github.com/afc-org/angular-tailwind" target="_blank">https://github.com/afc-org/vue-tailwind</a>
+- Issues: <a href="https://github.com/afc-org/react-tailwind/issues" target="_blank">Github Issues Page</a>

assets/logos/angular-tailwind-logo.png

@@ -1,5 +1,5 @@
 {
-  "name": "@tailwindjs/react-tailwindjs",
+  "name": "@afc/react-tailwind",
   "version": "0.1.0",
   "description": "Dynamic components for Tailwindcss and ReactJS",
   "main": "./src/index.js",
@@ -8,7 +8,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/tailwindjs/react-tailwindjs.git"
+    "url": "git+https://github.com/afc-org/react-tailwind.git"
   },
   "keywords": [
     "react",
@@ -22,14 +22,17 @@
     "react-tailwind",
     "react-tailwindcss",
     "react-tailwindjs",
-    "tailwindjs"
+    "tailwindjs",
+    "afc-org",
+    "afc",
+    "@afc"
   ],
-  "author": "@tailwindjs",
+  "author": "afc-org",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/tailwindjs/react-tailwindjs/issues"
+    "url": "https://github.com/afc-org/react-tailwind/issues"
   },
-  "homepage": "https://github.com/tailwindjs/react-tailwindjs#readme",
+  "homepage": "https://github.com/afc-org/react-tailwind#readme",
   "peerDependencies": {
     "@popperjs/core": "2.2.x",
     "classnames": "2.2.x",