mirror of
https://github.com/BoostIo/Boostnote
synced 2025-12-15 18:56:22 +00:00
Merge pull request #161 from twhiting/master
Updated readme english & reformatting
This commit is contained in:
77
readme.md
77
readme.md
@@ -1,35 +1,37 @@
|
|||||||
# Boostnote
|
<h1 align="center">
|
||||||
|
<a href="https://github.com/BoostIO/Boostnote"><img src="http://b00st.io/assets/img/logo.png" alt="Boostnote" width="180"></a>
|
||||||
|
<br>
|
||||||
|
Boostnote
|
||||||
|
<br>
|
||||||
|
<br>
|
||||||
|
</h1>
|
||||||
|
<h4 align="center">Note app built for developers. </h4>
|
||||||
|
<h5 align="center">macOS, Windows and Linux</h5>
|
||||||
|
<h5 align="center">Built with Electron, React + Redux, Webpack and CSSModules</h5>
|
||||||
|
<h1> </h1>
|
||||||
|
|
||||||
> We launched [Boostnote store](#goods)!! :tada: Also, you can support us from [Patreon](https://www.patreon.com/boostnote) and [Open collective](https://opencollective.com/boostnote)!
|
> We launched our [Boostnote store](#goods)!! :tada: Also, you can support us via [Patreon](https://www.patreon.com/boostnote) and [Open collective](https://opencollective.com/boostnote)!
|
||||||
|
|
||||||

|

|
||||||

|

|
||||||
|
|
||||||
Simple opensource note app for developer.
|
[日本語](./readme-ja.md) - [한국어](./readme-ko.md)
|
||||||
|
|
||||||
You can use the issue tracker of this repository for
|
## Goals
|
||||||
- asking a question about Boostnote
|
* We want our users to enjoying writing _anything_. :grinning:
|
||||||
- giving a feedback about Boostnote and its future plan
|
* Open sourced forever!
|
||||||
- reporting a bug of Boostnote
|
|
||||||
- wanting to contribute Boostnote
|
|
||||||
|
|
||||||
We have a slack if you want to engage us deeply, ask @rokt33r to join.
|
See upcoming features and bug fixes [here](https://github.com/BoostIO/Boostnote/issues/68)
|
||||||
|
## Feedback
|
||||||
|
Please use the [issue tracker](https://github.com/BoostIO/Boostnote/issues) for questions, bug reporting and contribution information.
|
||||||
|
|
||||||
- [日本語](./readme-ja.md)
|
## Development
|
||||||
- [한국어](./readme-ko.md)
|
If you want to join our dev Slack group ask @rokt33r.
|
||||||
|
**[Build instructions](docs/build.md)**
|
||||||
|
|
||||||
## Goal
|
[](https://github.com/feross/standard)
|
||||||
|
|
||||||
We just want you to enjoying writing anything. :grinning:
|
|
||||||
|
|
||||||
- Target OS : OSX, Windows, Linux(also mobile somewhen!)
|
|
||||||
- Cloud : Google drive, Dropbox, One drive, iCloud...
|
|
||||||
- Remaining opensource forever!
|
|
||||||
|
|
||||||
Check planned features [here](https://github.com/BoostIO/Boostnote/issues/68)!
|
|
||||||
|
|
||||||
## Inspired by
|
|
||||||
|
|
||||||
|
## Inspirations
|
||||||
- Atom
|
- Atom
|
||||||
- Quiver
|
- Quiver
|
||||||
- Evernote
|
- Evernote
|
||||||
@@ -39,42 +41,22 @@ Check planned features [here](https://github.com/BoostIO/Boostnote/issues/68)!
|
|||||||
- Gistbox
|
- Gistbox
|
||||||
- Snippets Lab
|
- Snippets Lab
|
||||||
|
|
||||||
## Using stack
|
## Store
|
||||||
|
|
||||||
- Electron
|
|
||||||
- React
|
|
||||||
- Webpack
|
|
||||||
- Redux
|
|
||||||
- CSSModules
|
|
||||||
|
|
||||||
## Codestyle
|
|
||||||
|
|
||||||
[](https://github.com/feross/standard)
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
- [Build](docs/build.md)
|
|
||||||
|
|
||||||
## Goods
|
|
||||||
|
|
||||||
<img src="https://b00st.io/images/t3.png" width="250"/>
|
<img src="https://b00st.io/images/t3.png" width="250"/>
|
||||||
<img src="https://b00st.io/images/t1.png" width="250"/>
|
<img src="https://b00st.io/images/t1.png" width="250"/>
|
||||||
|
|
||||||
We're currently selling some goods from [Boostnote store](https://boostnote.paintory.com/).
|
We're selling Boostnote goods on the [Boostnote store](https://boostnote.paintory.com/).
|
||||||
|
|
||||||
The product can be sent anywhere in the world. This store is powered by [Paintory](https://paintory.com/)
|
Products are shipped worldwide. Powered by [Paintory](https://paintory.com/)
|
||||||
|
|
||||||
## Donation
|
## Donation
|
||||||
|
* [Patreon](https://www.patreon.com/boostnote)
|
||||||
We launched a [Patreon page](https://www.patreon.com/boostnote).
|
* [Open collective](https://opencollective.com/boostnote)
|
||||||
Also, We've been approved [Open collective](https://opencollective.com/boostnote).
|
|
||||||
|
|
||||||
## Author & Maintainer
|
## Author & Maintainer
|
||||||
|
|
||||||
[Rokt33r(Dick Choi of MAISIN&CO.)](https://github.com/rokt33r)
|
[Rokt33r(Dick Choi of MAISIN&CO.)](https://github.com/rokt33r)
|
||||||
|
|
||||||
## Contributors
|
## Contributors
|
||||||
|
|
||||||
- [Kazu Yokomizo](https://github.com/kazup01)
|
- [Kazu Yokomizo](https://github.com/kazup01)
|
||||||
- [dojineko](https://github.com/dojineko)
|
- [dojineko](https://github.com/dojineko)
|
||||||
- [Romain Bazile](https://github.com/gromain)
|
- [Romain Bazile](https://github.com/gromain)
|
||||||
@@ -85,7 +67,6 @@ Also, We've been approved [Open collective](https://opencollective.com/boostnote
|
|||||||
- [tjado](https://github.com/tejado)
|
- [tjado](https://github.com/tejado)
|
||||||
|
|
||||||
## Copyright & License
|
## Copyright & License
|
||||||
|
|
||||||
Copyright (C) 2016 MAISIN&CO.
|
Copyright (C) 2016 MAISIN&CO.
|
||||||
|
|
||||||
[GPL v3](./LICENSE).
|
[GPL v3](./LICENSE).
|
||||||
|
|||||||
Reference in New Issue
Block a user