update doc

utsuboco · Oct 22, 2020 · 89753ee · 89753ee
1 parent b98f0a0
commit 89753ee
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -19,4 +19,4 @@ yarn create r3f-app <gatsby|next|cra|native> my-app <sass|styled>
 
 ## Documentation
 
-[documentation is available here](https://ueno-llc.github.io/create-r3f-app).
+[documentation is available here](https://renaudrohlinger.github.io/create-r3f-app).
diff --git a/docs/README.md b/docs/README.md
@@ -1,20 +1,3 @@
-[![logo](https://user-images.githubusercontent.com/937328/51313595-d7f90e80-1a45-11e9-8375-a94f03e52fc6.png)](https://ueno.co/?utm_source=github&utm_campaign=create-r3f-app)
-<br /><br />
-![banner](https://user-images.githubusercontent.com/937328/51313594-d7f90e80-1a45-11e9-8d25-28583da916fa.png)
-<br /><br />
-[![about](https://user-images.githubusercontent.com/937328/51540139-999c8e80-1e4d-11e9-866d-284657a34744.png)](https://ueno.co/contact/?utm_source=github&utm_campaign=create-r3f-app)
-<br /><br />
+# Create R3F App
 
-# Create Ueno App
-
-[![npm version](https://badge.fury.io/js/create-r3f-app.svg)](https://badge.fury.io/js/create-r3f-app)
-
-The easiest and fastest way to create new web projects with `next`, `gatsby`, `create-react-app` and mobile projects with `react-native`. All of them powered with Ueno's configs. All of our starters kits are shipped with everything to ship rock solid apps.
-
-- Opinionated dependencies
-- SASS and CSS modules or Styled components
-- Root resolver (import `components/header/Header`)
-- Server Side Rendering
-- Code splitting
-- React hooks
-- Prettier, lint-staged, husky, stylelint
+[![npm version](https://badge.fury.io/js/create-r3f-app.svg)](https://badge.fury.io/js/create-r3f-app)
diff --git a/docs/guide/NEXT.md b/docs/guide/NEXT.md
@@ -1 +1 @@
-# Ueno Next Starter
+# R3F Next Starter
diff --git a/docs/index.html b/docs/index.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
   <meta charset="UTF-8">
-  <title>Create Ueno App — The easiest and fastest way to create new web projects with next, gatsby, create-react-app and mobile projects with react-native.</title>
+  <title>Create R3F App</title>
   <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
   <meta name="description" content="The easiest and fastest way to create new web projects with next, gatsby, create-react-app and mobile projects with react-native.">
   <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
@@ -12,14 +12,14 @@
   <div id="app"></div>
   <script>
     window.$docsify = {
-      name: 'create-r3f-app',
-      repo: 'ueno-llc/create-r3f-app',
-      themeColor: '#6be5a0',
+      name: 'create-R3F-app',
+      repo: 'renaudrohlinger/create-r3f-app',
+      themeColor: '#111111',
       search: 'auto',
       loadSidebar: true,
       subMaxLevel: 2,
       auto2top: true,
-      ga: 'UA-113990173-1',
+      //ga: '',
     }
   </script>
   <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>

diff --git a/docs/setup/USAGE.md b/docs/setup/USAGE.md
@@ -1,15 +1,15 @@
 # Usage
 
-Create Ueno App supports 1 stack:
+Create R3F App supports 1 stack:
 
 ## Next
 
-NextJS with full server capabilities and static rendering. It uses [ueno-next-starter](https://github.com/ueno-llc/ueno-next-starter) as the base config.
+NextJS with full server capabilities and static rendering. It uses [r3f-next-starter](https://github.com/RenaudROHLINGER/r3f-next-starter) as the base config.
 
 ```bash
 yarn create r3f-app next example-www <styled|sass>
 ```
 
-!> The `project-name` will be generated using the path you defined. e.g. `example-www` will be `exampleWww` as the name for the app.
+!> The `project-name` will be generated using the path you defined.
 
 !> The last argument is the `bundle-id` and is required.
diff --git a/lib/index.js b/lib/index.js
@@ -14,7 +14,7 @@ const next = require('./stacks/next');
 // todo add gatsby and native
 const appTypes = ['next'];
 
-module.exports = async function createUenoApp({ projectName, appType }) {
+module.exports = async function createR3fApp({ projectName, appType }) {
   console.log(chalk.bold(chalk.green(`
   ———— Welcome to create-r3f-app
   `)));

diff --git a/lib/stacks/gatsby.js b/lib/stacks/gatsby.js
@@ -13,7 +13,7 @@ module.exports = async function gatsby(projectName, projectPath, projectStyle) {
   output.info(
     `🚀 Creating ${chalk.bold(chalk.green(projectName))} using ${chalk.bold(
       'gatsby-cli/lib/init-starter',
-    )} and ${chalk.bold('ueno-gatsby-starter')}...`,
+    )} and ${chalk.bold('r3f-gatsby-starter')}...`,
   );
 
   await require('gatsby-cli/lib/init-starter').initStarter(starter, { rootPath: projectName });

diff --git a/lib/utils/messages.js b/lib/utils/messages.js
@@ -24,7 +24,7 @@ exports.help = function () {
   return output.info(`Only ${chalk.green('<project-directory>')} is required.
 
   If you have any problems, do not hesitate to file an issue:
-    ${chalk.cyan('https://github.com/ueno/create-r3f-app/issues/new')}
+    ${chalk.cyan('https://github.com/RenaudROHLINGER/create-r3f-starter/issues/new')}
   `);
 };
 
@@ -60,7 +60,7 @@ exports.missingBundleId = function (projectName) {
   return output.error(
     `Oops! Looks like you forgot to defined the bundleId for ${chalk.red(
       projectName,
-    )}. Please define one e.g. "co.ueno.app"`,
+    )}. Please define one e.g. "co.r3f.app"`,
   );
 };
 

diff --git a/lib/utils/process-exit.js b/lib/utils/process-exit.js
@@ -9,7 +9,7 @@ module.exports = function processExit(projectPath, projectName, appType) {
     return;
   }
 
-  const readme = `# ${projectName}\n\nThis project was bootstrapped with [\`create-r3f-app\`](https://github.com/ueno-llc/create-r3f-app)`;
+  const readme = `# ${projectName}\n\nThis project was bootstrapped with [\`create-r3f-app\`](https://github.com/RenaudROHLINGER/create-r3f-app)`;
 
   try {
     fs.writeFileSync(path.join(projectPath, 'README.md'), readme);
Original file line number	Diff line number	Diff line change
Expand Up		@@ -19,4 +19,4 @@ yarn create r3f-app <gatsby\|next\|cra\|native> my-app <sass\|styled>

		## Documentation

		[documentation is available here](https://ueno-llc.github.io/create-r3f-app).
		[documentation is available here](https://renaudrohlinger.github.io/create-r3f-app).
-Original file line number
+Diff line change
@@ Expand Up @@
         return;
       }
-      const readme = `# ${projectName}\n\nThis project was bootstrapped with [\`create-r3f-app\`](https://github.com/ueno-llc/create-r3f-app)`;
+      const readme = `# ${projectName}\n\nThis project was bootstrapped with [\`create-r3f-app\`](https://github.com/RenaudROHLINGER/create-r3f-app)`;
       try {
         fs.writeFileSync(path.join(projectPath, 'README.md'), readme);
@@ Expand Down @@