github/Fabric
1
1
Fork 0
mirror of https://github.com/danielmiessler/Fabric.git synced 2026-01-09 22:38:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
John
2025-01-01 02:48:15 -05:00
parent c107cce22e
commit 2aebc84c66
4 changed files with 5 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
web/README.md
View File

@@ -9,7 +9,7 @@ The goal of this app is to not only provide a user interface for Fabric, but als
## Installing
It can be installed by navigating to the `web` directory and using `npm install`, `pnpm install`, or your preferred package manager. Then simply run `npm run dev` or your equivalent command to start the app. *You will need to run fabric in a seperate terminal with the `fabric --serve` command.*
The app can be run by navigating to the `web` directory and using `npm install`, `pnpm install`, or your preferred package manager. Then simply run `npm run dev`, `pnpm run dev`, or your equivalent command to start the app. *You will need to run fabric in a seperate terminal with the `fabric --serve` command.*
A production build is available as well. You can run it with `npm run preview` or using your preferred package manager
@@ -17,7 +17,11 @@ A production build is available as well. You can run it with `npm run preview` o
When creating new posts make sure to include a date, description, tags, and aliases. Only a date is needed to display a note.
### If you choose to use Obsidian along side ths app
You can design and order your vault however you like, though a `posts` folder should be kept in your vault to house any articles you'd like to post.
### Production
The production build has not been setup to run on any particular provider.