Skip to content

Commit

Permalink
update readme and mds
Browse files Browse the repository at this point in the history
  • Loading branch information
Ni55aN committed Apr 2, 2023
1 parent 3723989 commit c338981
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 93 deletions.
1 change: 1 addition & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Check out the [Code of Conduct](https://retejs.org/docs/code-of-conduct)
73 changes: 1 addition & 72 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,72 +1 @@
# Contribute

## Introduction

First, thank you for considering contributing to `rete`! It's people like you that make the open source community such a great community! 😊

We welcome any type of contribution, not only code. You can help with
- **QA**: file bug reports, the more details you can give the better (e.g. screenshots with the console open)
- **Documentation**: correcting grammatical or spelling errors, improving existing explanations and adding new ones
- **Marketing**: writing blog posts, howto's, printing stickers, ...
- **Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
- **Code**: take a look at the [open issues](issues). Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.
- **Money**: we welcome financial contributions in full transparency on [open collective](https://opencollective.com/rete) or [patreon](https://www.patreon.com/ni55an)

## Your First Contribution

Working on your first Pull Request? You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).

## Submitting code

Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.

## Code review process

The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge.
It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you?

## Documentation

The `docs/` folder contains documentation that deploys on [readthedocs.io](https://rete.readthedocs.io/en/latest/). All changes in this folder should be commited separately with prefix `[docs]`. It will also be submitted as a pull request.

## Financial contributions

We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/rete).
Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.

## Questions

If you have any questions, create an [issue](issue) (protip: do a quick search first to see if someone else didn't ask the same question before!) or send a quick questions to [Gitter](https://gitter.im/retejs/Lobby).
You can also reach us at [email protected].

## Credits

### Contributors

Thank you to all the people who have already contributed to rete!
<a href="graphs/contributors"><img src="https://opencollective.com/rete/contributors.svg?width=890" /></a>


### Backers

Thank you to all our backers! [[Become a backer](https://opencollective.com/rete#backer)]

<a href="https://opencollective.com/rete#backers" target="_blank"><img src="https://opencollective.com/rete/backers.svg?width=890"></a>


### Sponsors

Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/rete#sponsor))

<a href="https://opencollective.com/rete/sponsor/0/website" target="_blank"><img src="https://opencollective.com/rete/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/rete/sponsor/1/website" target="_blank"><img src="https://opencollective.com/rete/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/rete/sponsor/2/website" target="_blank"><img src="https://opencollective.com/rete/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/rete/sponsor/3/website" target="_blank"><img src="https://opencollective.com/rete/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/rete/sponsor/4/website" target="_blank"><img src="https://opencollective.com/rete/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/rete/sponsor/5/website" target="_blank"><img src="https://opencollective.com/rete/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/rete/sponsor/6/website" target="_blank"><img src="https://opencollective.com/rete/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/rete/sponsor/7/website" target="_blank"><img src="https://opencollective.com/rete/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/rete/sponsor/8/website" target="_blank"><img src="https://opencollective.com/rete/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/rete/sponsor/9/website" target="_blank"><img src="https://opencollective.com/rete/sponsor/9/avatar.svg"></a>

<!-- This `CONTRIBUTING.md` is based on @nayafia's template https://github.com/nayafia/contributing-template -->
Check out the [Contribution guide](https://retejs.org/docs/contribution)
52 changes: 31 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
Rete.js [![Build Status](https://app.travis-ci.com/retejs/rete.svg?branch=master)](https://app.travis-ci.com/retejs/rete)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=retejs_rete&metric=alert_status)](https://sonarcloud.io/dashboard?id=retejs_rete)
[![Join the chat at https://gitter.im/retejs/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/retejs/Lobby)
Rete.js
====
#### JavaScript framework for visual programming
[![Made in Ukraine](https://img.shields.io/badge/made_in-ukraine-ffd700.svg?labelColor=0057b7)](https://stand-with-ukraine.pp.ua)
[![Discord](https://img.shields.io/discord/1081223198055604244?color=%237289da&label=Discord)](https://discord.gg/cxSFkPZdsV)

![rete logo](https://i.imgur.com/rydGu6B.png)
**JavaScript framework for visual programming**

#StandWithUkraine 💛💙
![rete logo](https://raw.githubusercontent.com/retejs/rete/assets/preview.svg)

#StandWithUkraine 💙💛
----

#RussiaInvadedUkraine on 24 of February 2022, at 5.00 AM the armed forces of the Russian Federation attacked Ukraine. Please, Stand with Ukraine, stay tuned for updates on Ukraine’s official sources and channels in English and support Ukraine in its fight for freedom and democracy in Europe.
Expand All @@ -18,27 +19,36 @@ Help to defend Ukraine — donate to the [fund of the National Bank of Ukraine](

Introduction
----
**Rete** is a modular framework for visual programming. **Rete** allows you to create node-based editor directly in the browser. You can define nodes and workers that allow users to create instructions for processing data in your editor without a single line of code.

Documentation
----
Check the [docs](https://rete.js.org/#/docs) and learn about the components and capabilities.
**Rete.js** is a framework for creating visual interfaces and workflows. It provides out-of-the-box solutions for visualization using various libraries and frameworks, as well as solutions for processing graphs based on dataflow and control flow approaches.

Examples
Getting Started
----
[Flow-based programming](https://codepen.io/Ni55aN/pen/xzgQYq)

[Events (tasks)](https://codepen.io/Ni55aN/pen/MOYPEz)
- [Concepts](https://retejs.org/docs/concepts/plugin-system)
- [Guides](https://retejs.org/docs/guides/basic)
- [FAQ](https://retejs.org/docs/faq)
- [Examples](https://retejs.org/examples)

[Modules](https://codepen.io/Ni55aN/pen/QOEbEW)
## Sponsors

[Programming a Messenger Bot](https://codepen.io/Ni55aN/pen/rpOKNb)
Thank you to all our sponsors! [Become a sponsor](https://opencollective.com/rete#sponsor)

[3D Car configurator](https://codesandbox.io/embed/9jp88p1jpy?view=preview)
<a href="https://opencollective.com/rete#sponsors" target="_blank"><img src="https://opencollective.com/rete/sponsors.svg?width=890"></a>

License
----
[MIT](http://opensource.org/licenses/MIT)
## Backers

Thank you to all our backers! [Become a backer](https://opencollective.com/rete#backer)

<a href="https://opencollective.com/rete#backers" target="_blank"><img src="https://opencollective.com/rete/backers.svg?width=890"></a>


## Contributors

This project exists thanks to all the people who contribute. [Contribute](https://retejs.org/docs/contribution).

<a href="https://github.com/retejs/rete/graphs/contributors"><img src="https://opencollective.com/rete/contributors.svg?width=890" /></a>

## License

[Donate](http://rete.js.org/#support)
---
[MIT](https://github.com/retejs/rete/blob/master/LICENSE)

0 comments on commit c338981

Please sign in to comment.