Skip to content
This repository was archived by the owner on Oct 18, 2023. It is now read-only.

Commit 15c4901

Browse files
committed
Update README.md
1 parent 1f634a9 commit 15c4901

File tree

1 file changed

+49
-38
lines changed

1 file changed

+49
-38
lines changed

README.md

Lines changed: 49 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,49 @@
1-
<p align="center"><img src="https://i.imgur.com/NZfsD1p.png"></p>
2-
3-
## Usage
4-
5-
### Create an App
6-
7-
```
8-
# with npx
9-
$ npx create-nextron-app my-app --example with-typescript
10-
11-
# with yarn
12-
$ yarn create nextron-app my-app --example with-typescript
13-
14-
# with pnpx
15-
$ pnpx create-nextron-app my-app --example with-typescript
16-
```
17-
18-
### Install Dependencies
19-
20-
```
21-
$ cd my-app
22-
23-
# using yarn or npm
24-
$ yarn (or `npm install`)
25-
26-
# using pnpm
27-
$ pnpm install --shamefully-hoist
28-
```
29-
30-
### Use it
31-
32-
```
33-
# development mode
34-
$ yarn dev (or `npm run dev` or `pnpm run dev`)
35-
36-
# production build
37-
$ yarn build (or `npm run build` or `pnpm run build`)
38-
```
1+
<center>
2+
<img src="https://raw.githubusercontent.com/BytesToBits/LockPass/main/resources/splash-icon.gif" height="300px" margin="0 auto 0 auto" />
3+
<h1><strong><em>LOCKPASS, A PASSWORD MANAGER</em></strong></h1>
4+
</center>
5+
6+
# **LockPass**
7+
> *LockPass is a simple passsword manager made using [Electron](https://electronjs.org/) + [Next.js](https://nextjs.org/) ([Nextron](https://github.com/saltyshiomix/nextron/)).*
8+
9+
## How it works
10+
- Head over to the [Releases](https://github.com/BytesToBits/LockPass/releases) tab and download the latest version. The file you must downlaod must be formatted like so: `LockPass-Setup-[VERSION].exe`
11+
- Run the downlaoded file. Chrome and Windows might try to prevent its download, but you can discard the alerts if you wish. There are no threats in the applications whatsoever.
12+
- Whenever there is a new release, the application will update automatically.
13+
- Passwords are saved __locally__, so there is no fear of having them leaked online.
14+
15+
## To-Do
16+
- Improve the overall design
17+
- Settings panel allowing more features to be used
18+
- A more protective way of storing passwords (encryptions & user pin)
19+
20+
21+
# **Contributions**
22+
All contributions are welcome! Feel free to work on any of the above To-Do features. Make sure, however, that your commit messages follow the guidelines below to make it easier for us to track. *it's fine if you don't*
23+
1. **Select the type of commit:**
24+
`feat`: The new feature you're adding to a particular application
25+
`fix`: A bug fix
26+
`style`: Feature and updates related to styling
27+
`refactor`: Refactoring a specific section of the codebase
28+
`test`: Everything related to testing
29+
`docs`: Everything related to documentation
30+
`chore`: Regular code maintenance.[ You can also use emojis to represent commit types]
31+
2. **Separate the subject from the body with a blank line**
32+
3. **Your commit message should not contain any whitespace errors**
33+
4. **Remove unnecessary punctuation marks**
34+
5. **Do not end the subject line with a period**
35+
6. **Capitalize the subject line and each paragraph**
36+
7. **Use the imperative mood in the subject line**
37+
8. **Use the body to explain what changes you have made and why you made them.**
38+
9. **Do not assume the reviewer understands what the original problem was, ensure you add it.**
39+
10. **Do not think your code is self-explanatory**
40+
> ***Read [this article](https://www.freecodecamp.org/news/writing-good-commit-messages-a-practical-guide/) to learn more***
41+
42+
Once you are done with your contribution, create a [Pull Request](https://github.com/BytesToBits/LockPass/pulls)!
43+
44+
<center style="margin-top:30px">
45+
<h1><strong><em>💖 CONTRIBUTORS 💖</em></strong></h1>
46+
<a href="https://github.com/BytesToBits/LockPass/graphs/contributors">
47+
<img src="https://contrib.rocks/image?repo=bytestobits/LockPass" />
48+
</a>
49+
</center>

0 commit comments

Comments
 (0)