readme update, remove broken close

jackyzha0 · Jun 27, 2021 · 2d1c501 · 2d1c501
1 parent f5375cc
commit 2d1c501
Show file tree

Hide file tree

Showing 10 changed files with 24 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -1,15 +1,19 @@
+![Banner](assets/logo.png)
+---
+
 # portal
 A two-way p2p folder syncing tool build on top of the [Hypercore protocol](https://hypercore-protocol.org/).
 
-## TODO:
-- [ ] tests :((
-    - [ ] hooks → https://github.com/testing-library/react-hooks-testing-library
-    - [ ] components → https://github.com/vadimdemedes/ink-testing-library
-    - [ ] registry → regular ava
-- [ ] packaging + redistribution
-    - [ ] update notifier: https://www.npmjs.com/package/update-notifier
-- [ ] write readme
-    - [ ] demo video
+## Installation
+```shell
+$ npm install --global portal-sync
+
+# Start using portal
+$ portal new
+
+# or 
+$ portal join [sessionID]
+```
 
 ## Features
 read/write streams for files of arbitrary size

diff --git a/assets/logo.png b/assets/logo.png
diff --git a/commands/join.tsx b/commands/join.tsx
@@ -78,7 +78,7 @@ const Client = ({dir, isForceOverwrite, sessionId, verbose, tree}: IClientProps)
           <FileTree registry={registryRenderableArray} full={tree}/>
           <Stats registry={registryRenderableArray} totalBytes={stats.totalBytes} bytesPerSecond={stats.bytesPerSecond}/>
         </DisplayComponent>
-        <Hotkeys close={hyper.hyperObj?.close}/>
+        <Hotkeys/>
         <Errors errors={errors}/>
       </Box>
     </AppContextProvider>

diff --git a/commands/new.tsx b/commands/new.tsx
@@ -39,7 +39,7 @@ const Host = ({dir, includeGitFiles, verbose, tree}: IHostProps) => {
           <FileTree registry={registryRenderableArray} full={tree}/>
           <Stats registry={registryRenderableArray} totalBytes={stats.totalBytes} bytesPerSecond={stats.bytesPerSecond}/>
         </DisplayComponent>
-        <Hotkeys close={hyper.hyperObj?.close}/>
+        <Hotkeys/>
         <Errors errors={errors}/>
       </Box>
     </AppContextProvider>

diff --git a/components/FileTree.tsx b/components/FileTree.tsx
@@ -81,6 +81,7 @@ const TruncatedTreeFile = ({file}: {file: ITreeRepresentation}) => (
 )
 
 // File tree display component
+const DISPLAY_NUM = 50
 const FileTree = ({registry, full}: IFileTreeProps) => {
   const emptyMessage = full ?
     <Text color="yellow">No files found</Text> :
@@ -89,9 +90,10 @@ const FileTree = ({registry, full}: IFileTreeProps) => {
   return (
     <Box flexDirection="column" marginY={1}>
       <Text bold>Files</Text>
-      {files.length > 0 ? files.map((file, i) => (
+      {files.length > 0 ? files.slice(0, 50).map((file, i) => (
         full ? <FullTreeFile key={i} file={file}/> : <TruncatedTreeFile key={i} file={file}/>
       )) : emptyMessage}
+      {files.length > 50 && <Text bold color="cyan">...and {files.length - DISPLAY_NUM} more collapsed</Text>}
       {full && <Legend/>}
     </Box>
   )

diff --git a/components/Hotkeys.tsx b/components/Hotkeys.tsx
@@ -4,13 +4,9 @@ import useHotkey from '../hooks/useHotkey'
 import {useAppContext} from '../contexts/App'
 import Loader from './Loader'
 
-interface IHotkeysProps {
-  close: undefined | (() => Promise<void>);
-}
-
 // Hotkey component to listen for hotkeys to exit
-const Hotkeys = ({close}: IHotkeysProps) => {
-  useHotkey(close)
+const Hotkeys = () => {
+  useHotkey()
   const {closed} = useAppContext()
   return closed ?
     <Loader status="Cleaning up..." color="yellow"/> :

diff --git a/contexts/App.tsx b/contexts/App.tsx
@@ -45,7 +45,7 @@ export const AppContextProvider = ({children, hyper}: IAppContextProviderProps)
           <Text color="red">Error connecting to hypercore: </Text>
           <Text>{hyper.error}</Text>
         </Text>
-        <Hotkeys close={hyper.hyperObj?.close}/>
+        <Hotkeys/>
       </>
     )
   }

diff --git a/hooks/useDebouncedState.ts b/hooks/useDebouncedState.ts
@@ -11,7 +11,6 @@ const useDebouncedState = (registry: Registry) => {
 
   useEffect(() => {
     update()
-
     const handler = setTimeout(() => {
       update()
     }, 1000 / TARGET_REFRESH_RATE)

diff --git a/hooks/useHotkey.ts b/hooks/useHotkey.ts
@@ -1,19 +1,14 @@
-import {promisify} from 'util'
 import {useApp, useInput} from 'ink'
 import {useAppContext} from '../contexts/App'
 
-const useHotkey = (close: undefined | (() => void)) => {
+const useHotkey = () => {
   const {exit} = useApp()
   const {setClosed} = useAppContext()
   useInput((input, key) => {
     if (input === 'q' || key.escape) {
       setClosed()
       exit()
-      if (close) {
-        promisify(close)().finally(() => process.exit())
-      } else {
-        process.exit()
-      }
+      process.exit()
     }
   })
 }

diff --git a/hooks/useUpdateNotify.ts b/hooks/useUpdateNotify.ts
@@ -4,7 +4,7 @@ import pkg from '../package.json'
 
 const useUpdateNotify = () => {
   useEffect(() => {
-    updateNotifier({pkg}).notify()
+    updateNotifier({pkg}).notify({isGlobal: true})
   }, [])
 }