Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alagrede authored Jun 19, 2024
1 parent 4892da8 commit 9d38583
Showing 1 changed file with 52 additions and 14 deletions.
66 changes: 52 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,69 @@
# Znote - The note-taking app for Doers

**Znote** is your ultimate note-taking companion that transforms your simple notes into actionable steps. Designed with developers and productivity enthusiasts in mind, Znote leverages the power of Markdown and JavaScript to make your notes more dynamic and interactive.

## What is Znote?

**Znote** is a Beautiful markdown editor inspired by Jupyter.
Znote is a note-taking app that not only allows you to capture your thoughts but also enables you to create **dashboards** and **automate tasks** directly within your notes. With the integration of **templates and AI**, Znote simplifies complex tasks and **boosts your productivity**.

<img width="1000" alt="editor-wysiwyg" src="https://github.com/alagrede/znote-app/assets/5312754/0dff4417-276a-4870-90dc-507806ecb323">

### Key Features:

Your best companion for **prototyping** and centralizing your **scripts**.
- **Actionable Notes**: Write notes that can trigger actions using embedded JavaScript.
- **Markdown Support**: Enjoy the simplicity and flexibility of Markdown for formatting your notes.
- **Dynamic Dashboards**: Seamlessly create and manage interactive dashboards from your notes.
- **Automations**: Automate repetitive tasks directly from your notes to streamline your workflow.
- **Templates & AI**: Leverage a variety of templates and AI tools to deploy and manage code blocks effortlessly.

## Getting Started

[https://znote.io](https://znote.io)
### Download

![Screenshot](https://github.com/alagrede/znote-app/blob/master/screenshot-github1.png)
Znote is available for the following platforms:

![Screenshot](https://github.com/alagrede/znote-app/blob/master/screenshot-github3.png)
- **Windows**
- **Mac**
- **Linux**

You can download the app from the [official website](https://znote.io).

### Installation

## Download
App is available on Windows/Mac Store.
To install Znote on your preferred platform, follow these steps:

You can also download Linux and alternative binaries from the [Github releases](https://github.com/alagrede/znote-app/releases) section.
1. **Windows**: Download the `.exe` file and run the installer.
2. **Mac**: Download the `.dmg` file, open it, and drag Znote to your Applications folder.
3. **Linux**: Download the `.AppImage` file and follow the standard installation process.

## Stay Updated

Subscribe to our newsletter on the [Znote website](https://znote.io) to receive the latest tutorials, tips, and updates.

## Contact
Email: lagrede.anthony[at]gmail.com

This public website
znote.io public website
For any queries or support, feel free to reach out via email:

- **Email**: lagrede.anthony[at]gmail.com

You can also visit our public website: [znote.io](https://znote.io).

## Report bugs
Feel free to use the [issues](https://github.com/alagrede/znote-app/issues) section.
## Contributing

We welcome contributions to improve Znote! If you encounter any issues or have suggestions for new features, please use the [discussions](https://github.com/alagrede/znote-app/discussions) section on GitHub.

## Reporting Bugs

If you find any bugs, please report them by creating an issue in the [issues section](https://github.com/alagrede/znote-app/issues) on GitHub.

## Credits
Build with [Electron](electronjs.org) and [React](https://fr.reactjs.org/)

Znote is built with love using:

- [Electron](https://www.electronjs.org/)
- [React](https://reactjs.org/)

---

Thank you for using Znote! We're excited to see how you leverage it to boost your productivity and simplify your work. 🚀

0 comments on commit 9d38583

Please sign in to comment.