Skip to content

Commit 7b17df4

Browse files
committed
Polish for 1.1.0
* Write a README * Update package
1 parent 1f26df0 commit 7b17df4

2 files changed

Lines changed: 22 additions & 2 deletions

File tree

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,21 @@
1-
This is a starter template for [Learn Next.js](https://nextjs.org/learn).
1+
# Borum Jot Web App
2+
3+
Borum Jot Web App is a next-generation note and task management app for Borum users. It uses the Borum Jot API to access encrypted data, share notes between users, and present jottings.
4+
5+
## Installation
6+
7+
This project uses Next.js, a modern React framework, to generate the site. It also uses dependencies such as TypeScript and Material that one can install using npm. To install this project and view it locally:
8+
9+
1. Run `npm install` (one time)
10+
2. Run `npm run dev`
11+
3. Open `localhost:3000` in your browser
12+
13+
You can also set up a task within your IDE to run steps 2 and 3 automatically.
14+
15+
## Usage
16+
17+
To use it, go to https://jot.bforborum.com to log in. If you do not already have a Borum account, go to https://accounts.bforborum.com to make one.
18+
19+
## Contributors
20+
21+
This project is made by Varun Singh and is part of the Borum Tech ecosystem.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"author": {
55
"name": "Varun Singh"
66
},
7-
"version": "1.0.0",
7+
"version": "1.1.0",
88
"private": true,
99
"scripts": {
1010
"dev": "next dev",

0 commit comments

Comments
 (0)