Skip to content

Commit 9bba2de

Browse files
committed
docs:update README
also set fuzzy to be true by default
1 parent 40d60c1 commit 9bba2de

File tree

2 files changed

+26
-40
lines changed

2 files changed

+26
-40
lines changed

README.md

+25-39
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,38 @@
1-
# vaunch
1+
<h1><img src="public/favicon.svg" width="25" height="25"> Vaunch</h1>
22

3-
This template should help get you started developing with Vue 3 in Vite.
3+
A command-driven, customisable start-page.
44

5-
## Recommended IDE Setup
5+
Vaunch can be accessed at: https://vaunch.kirimson.com, or you can host it yourself. See [Setting Up](#setting-up) for more information on how to self-host Vaunch
66

7-
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin).
7+
## Features
88

9-
## Type Support for `.vue` Imports in TS
9+
- Folders to organise your links however you want
10+
- Linux-esc commands to interact with Vaunch
11+
- 'Link' files to go to a specified site, like a bookmark
12+
- 'Query' files to go to customised URLs based on your input, e.g using a search engine, or navigating to a specific Github repository
13+
- Customisable:
14+
- Icons for both files and folders can be set, using the free [Font Awesome](https://fontawesome.com/) icon set
15+
- GUI elements can be hidden, for more minimalist design
16+
- Can change the window, text, and text-highlight colour
17+
- Local Data
18+
- All data is stored locally in your browser's Local Storage. None of your configuration is stored on a remote server.
19+
- Your config can be exported, shared, edited, and imported easily
20+
- Fuzzy search to quickly find and go to/search commonly used sites
1021

11-
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
22+
## Usage
1223

13-
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
24+
While using Vaunch, to get help on any of the available commands, just type `help` in the input box, or find the `help` command in the Commands window. The help window will list all available commands with a description, their available parameters, and some examples of using the command.
1425

15-
1. Disable the built-in TypeScript Extension
16-
1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
17-
2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
18-
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
26+
On Vaunch's first start, there will be no files or folders created. To make one, just type `mkdir folderName` to create a folder, and `touch folderName/fileName.lnk siteName.tld/path` to create a Link file going to any website. (More information on `mkdir` and `touch` can be found on Vaunch's Help window)
1927

20-
## Customize configuration
28+
## Setting Up
2129

22-
See [Vite Configuration Reference](https://vitejs.dev/config/).
30+
Vaunch is written in Typescript, and uses Vue 3 (with Vite) as its framework. To install all dependencies for Vaunch, clone this repo and run `npm i` within the root directory.
2331

24-
## Project Setup
32+
Font Awesome's CSS also needs to be added into `src/assets/fontawesome/`, see [Host Font Awesome Yourself](https://fontawesome.com/v5/docs/web/setup/host-font-awesome-yourself) for any details.
2533

26-
```sh
27-
npm install
28-
```
34+
To run a development instance, run `npm run dev`, or `vite`.
2935

30-
### Compile and Hot-Reload for Development
36+
Building vaunch into `dist/` can be done with `npm run build` or `vue-tsc --noEmit && vite build`
3137

32-
```sh
33-
npm run dev
34-
```
35-
36-
### Type-Check, Compile and Minify for Production
37-
38-
```sh
39-
npm run build
40-
```
41-
42-
### Run Unit Tests with [Vitest](https://vitest.dev/)
43-
44-
```sh
45-
npm run test:unit
46-
```
47-
48-
### Lint with [ESLint](https://eslint.org/)
49-
50-
```sh
51-
npm run lint
52-
```
38+
After Vaunch has been built, it can be served with any static HTTP server poitned at Vaunch's `dist/` directory, such as [NGINX](https://www.nginx.com/), [HAProxy](http://www.haproxy.org/), [Apache](https://httpd.apache.org/) , or any node-based static site server, like [Serve](https://www.npmjs.com/package/serve).

src/stores/config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export const defaultconfig = {
77
showGUI: true,
88
titleCase: true,
99
defaultFile: "",
10-
fuzzy: false,
10+
fuzzy: true,
1111
showCommands: true,
1212
prefix: {
1313
class: "solid",

0 commit comments

Comments
 (0)