diff --git a/README.md b/README.md index b56b72540..1a2eae060 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,44 @@ +Ce repo contient : +- Le code source du site [mon-entreprise.fr](https://mon-entreprise.fr) +- La documentation et le code source du langage [publicodes](https://publi.codes) + +### Mon-entreprise.fr ![logo mon-entreprise.fr](https://mon-entreprise.fr/images/logo.svg) +Site développé en partenariat avec l'Urssaf, qui a pour mission d'accompagner des créateurs d’entreprise dans le développement de leur activité. + +Il propose notamment des simulateurs de cotisations sociales très complets, basés sur le language déclaratif publicodes. On peut ainsi calculer le coût d'une embauche, un salaire net après impôt, ses revenus d'auto-entrepreneur ou encore ceux d'un dirigeant de SASU ou d'indépendant +> 🧮 [Voir la liste des simulateurs](https://mon-entreprise.fr/simulateurs) + +Les développeurs ont la possibilité d'intégrer ces simulateurs sur d'autres sites, ou de réutiliser les règles pour effectuer leur propre calculs. +> 🧰 [Voir les outils à disposition des développeurs](https://mon-entreprise.fr/int%C3%A9gration) + + +### Publicodes + +Publicodes est un langage déclaratif pour encoder les algorithmes d'intérêt public. Il permet de réaliser des calculs généraux tout en fournissant une explication permettant de comprendre et de documenter ces calculs. + +Publicode est adapté pour modéliser des domaines métiers complexes pouvant être décomposés en règles élémentaires simples (comme la législation socio-fiscale, un bilan carbone, un estimateur de rendement locatif, etc.). Il propulse les simulateurs de mon-entreprise.fr et le site [futur.eco](https://futur.eco). + +> 📖 [Voir la documentation](https://publi.codes) + + +## Contribuer + +Si vous souhaitez contribuer à l'un des deux projet, rendez-vous sur [CONTRIBUTING.md](./CONTRIBUTING.md). + + +## 🇬🇧 English users + This repository powers [mycompanyinfrance.fr](https://mycompanyinfrance.fr) and [mon-entreprise.fr](https://mon-entreprise.fr) and [publi.codes](https://publi.codes). -The hiring simulator, available on both websites, embeds a [model](https://github.com/betagouv/mon-entreprise/blob/master/mon-entreprise/source/rules) of the french tax system as a YAML domain specific language. It enables displaying the computing rules on the Web and having a single source of logic for both the computation engine (a JS library) and the generated end-user conversation-like form. +Most of the documentation (including issues and commit message) is written in french, please raise an [issue](https://github.com/betagouv/mon-entreprise/issues/new) if you are interested and do not speak French. -The engine with the French tax law is available as a NPM module and explained [on the wiki](https://github.com/betagouv/mon-entreprise/wiki/Librairie-de-calcul). - -Developed by the french public startup incubator, [beta.gouv.fr](https://beta.gouv.fr/), with the help of the social security contributions collector, [URSSAF](www.urssaf.fr). - -Most of the documentation (including issues and the wiki) is written in french, please raise an [issue](https://github.com/betagouv/mon-entreprise/issues/new) if you are interested and do not speak French. - -## Contribute - -If you want to contribute to this application, please check out [CONTRIBUTING.md](./CONTRIBUTING.md). - -## Supported browsers +## 🗜️ Compatibility The website will run well on modern browsers. Internet Explorer is not supported anymore (it should work but with visual glitches and performance issues). This compatibility is tested thanks to [BrowserStack](http://browserstack.com/)'s free open source program. ![Logo de Browserstack, notre solution de tests manuels](https://i.imgur.com/dQwLjXA.png) +