Commit Graph

213 Commits

Author SHA1 Message Date
Neil Cuzon 0c6f8b58a3
Update README.md 2022-02-28 00:03:54 -08:00
Neil Cuzon 4593d8742d
Update README.md 2022-02-28 00:01:03 -08:00
Knut Sveidqvist b3573e27be chore: readme sync, 1 2022-02-24 19:23:44 +01:00
Knut Sveidqvist 43854a2921 Merge branch 'master' into develop 2022-02-17 18:25:00 +01:00
Knut Sveidqvist ed39de8426 docs: adding info on sandbox security to readme 2022-02-17 18:20:43 +01:00
Kai d818551f50
docs(README*.md): http => https (#2727) 2022-02-14 15:56:59 -08:00
Knut Sveidqvist c19319f115 fix: adding example code 2022-01-28 10:39:48 +01:00
Knut Sveidqvist ff3bdfd282 fix: using real diagrams in the readme file 2022-01-28 10:26:10 +01:00
Knut Sveidqvist 4130386447 fix: formatting test 2022-01-28 09:49:07 +01:00
Knut Sveidqvist 9c04595ae8 fix: update 2 2022-01-28 09:19:07 +01:00
Knut Sveidqvist d1c7f1c2e3 fix: switch to real mermaid diagrams instaead of images in readme 2022-01-28 09:14:12 +01:00
Knut Sveidqvist 8938d3656e
Adding info on how to report vulnerabilities 2022-01-18 08:39:26 +01:00
Erhannis 9bd5652b88
Change "graph" to "flowchart"
It seems like the keyword "graph" has been deprecated in favor of "flowchart".  There are some features that "flowchart" renders that "graph" doesn't - the new arrowheads, for instance.  If there's not a reason to leave it as "graph", I propose the example be updated to avoid confusion.
2022-01-07 00:14:45 -05:00
Lukas Klingsbo b7abaf1e47
Change "Help wanted!" to "Good first issue!" shield (#2533) 2021-12-05 13:10:41 -08:00
Ashish Jain b2f93b49ba
Merge pull request #2373 from lexmin0412/docs/chinese-readme
docs: add Chinese README
2021-10-07 19:24:56 +02:00
lexmin0412 b0b85e12a6 docs: add Chinese README 2021-10-03 00:02:40 +08:00
Knut Sveidqvist 6b0105cc3b Switch banner in README file 2021-09-23 18:52:08 +02:00
Knut Sveidqvist 768536b9e2
Adding banner for the book about Mermaid 2021-08-11 18:28:35 +02:00
Anish Karandikar 6379320b83
docs(README): Point to live editor
Perhaps it makes more sense to point directly to the live editor where a user can start playing around, instead of the repo for the live editor (which is still reachable from the editor itself).
2021-07-11 10:45:48 -07:00
Knut Sveidqvist 2bb4f1f875 Updated readme file 2021-04-25 14:05:42 +02:00
Knut Sveidqvist 88447f87d6 Removed test banner 2021-04-25 13:13:30 +02:00
Knut Sveidqvist 68a5f36f25 Test commit 2021-01-28 21:29:40 +01:00
Knut Sveidqvist bb42f78bef Tets commit 2021-01-28 20:57:21 +01:00
Knut Sveidqvist 9a928295fa Merge remote-tracking branch 'origin/master' 2021-01-21 21:22:14 +01:00
Knut Sveidqvist b2f52baa99 Adding buy me a coffe button 2021-01-11 21:55:23 +01:00
Knut Sveidqvist c3209e7738
Removed a 2020-12-03 18:25:46 +01:00
Nitin Lodha 6542134e04
Update README.md 2020-12-01 09:38:07 +05:30
sy-records cb41569a5a feat: Auto generation of Edit this Page 2020-11-15 10:28:47 +08:00
Levente Laszlo b89f79d901 fix broken links in README 2020-10-29 20:21:21 +01:00
NeilCuzon 445daaeba2 Switching to Docsify and adding search 2020-10-25 00:30:20 -07:00
Knut Sveidqvist 1ade6cdfa5
Merge pull request #1728 from alexislefebvre/patch-1
README: use stateDiagram-v2
2020-10-15 19:46:37 +02:00
Alexis Lefebvre 1a91b1bd42
README: use stateDiagram-v2 2020-10-14 17:23:10 +02:00
Andreas Deininger 5e95d75f44 Fixing broken links 2020-10-14 13:47:20 +02:00
Christian Martin eb3ddbcca7 Update link to Open Source Awards 2020-09-24 14:38:37 -07:00
Kees Hink c62f3c2898 Fix spelling: it's -> its
If you mean "the ... that it has", use its. If you mean "it is", use it's.
2020-08-28 09:31:09 +02:00
Neil Cuzon 459e07834c
Update README.md 2020-08-25 04:07:55 -07:00
Neil Cuzon c7e7f3b4c1
Update README.md 2020-08-25 04:05:41 -07:00
Neil Cuzon 78a8ae3ba2
Merge pull request #1633 from Mogztter/doc/changelog
Merge changelog and Mermaid Versions
2020-08-25 03:27:58 -07:00
Guillaume Grossetie 56a9b8fa94
Fix image path 2020-08-23 15:13:28 +02:00
Guillaume Grossetie ab130900a1 Merge changelog and Mermaid versions 2020-08-23 15:08:25 +02:00
Guillaume Grossetie 78f43b6e13 Condense about section 2020-08-15 15:10:09 +02:00
Guillaume Grossetie bbaf7583e4
Improve readme readability
- Fix link to changelog
- Remove changelog from readme
- Use titles sparsely
- Add emojis! 🎉
2020-08-15 14:59:34 +02:00
H3RSKO 25402c708e
Updatd Readme
Fixed Readme typo:

Changed "resposibility" to "responsibility"
2020-08-14 18:18:28 -04:00
Neil Cuzon 439e735d4b
Update README.md 2020-07-31 21:20:28 -07:00
Neil Cuzon af60a4d407
Update README.md 2020-07-31 19:54:46 -07:00
Neil Cuzon c9a6dc4fab
Update README.md 2020-07-31 19:14:07 -07:00
Neil Cuzon 9c647dc57a
Update README.md 2020-07-31 17:00:57 -07:00
Neil Cuzon 27bed22fee
Update README.md 2020-07-31 00:55:01 -07:00
Neil Cuzon aae69fa599
Update README.md 2020-07-31 00:38:03 -07:00
Maicon Schmitz 75fe500305
Update README.md
Correction off CLI link, in Related projects section
2020-06-25 11:24:45 -03:00
Knut Sveidqvist 44d5009538 Revert of PR #1482 2020-06-19 10:52:20 +02:00
Andrea D d7fc658bae fix: Update cli link in the Readme 2020-06-15 14:11:54 +02:00
Russell Geraghty 346ff199c6 Updated doc link 2020-04-28 08:45:41 +01:00
Russell Geraghty 480a4a9d38 Match title to example 2020-04-28 08:42:43 +01:00
Russell Geraghty 77cfd0e1a6 Colours 2020-04-28 08:40:48 +01:00
Russell Geraghty 950af2e753 Tidy up documentation, correct rendering in test 2020-04-28 08:28:16 +01:00
Russell Geraghty 249a14f84a Merge remote-tracking branch 'upstream/develop' into feature/user-journey 2020-04-17 07:30:53 +01:00
Tom Wright 12d26d5a3d Add HTTP Server implementation to related projects. 2020-04-15 19:29:17 +01:00
Russell Geraghty f081527731 User journey handler 2020-04-04 16:38:30 +01:00
Lukas Wöhrl 7bc82365c6
Update README.md 2020-02-29 20:55:20 +01:00
Neil Cuzon 5103da09c5
Update README.md 2020-02-27 00:37:24 -08:00
Neil Cuzon 33ea1d44fb
Merge branch 'develop' into develop 2020-02-27 00:32:17 -08:00
Justin Greywolf 4b064dc19f 1264-Update documentation
Reorder main readme.md file, add link to integrations - and add list of areas where mermaid is used
2020-02-25 13:11:08 -08:00
Neil Cuzon a26fe71171
Update README.md 2020-02-24 11:19:50 -08:00
NeilCuzon cd8b7e5528
Update README.md
Hi, I love your program and how it reimagines the whole dynamic of creating diagrams and graphs, I also like the wit of the documentation, but I had some small trouble in initially figuring out what the application was about. 

I propose a few line changes to clarify the purpose of the application and an additional a link to the syntax section of docs to  hopefully decrease the friction and increase the interest in using the product.  
I changed:
-"__mermaid is a Javascript based diagramming and charting tool. It generates diagrams flowcharts and more, using markdown-inspired text for ease and speed.__"
and I added:
-"__The following are some examples of the diagrams, charts and graphs that can be made using mermaid and the Markdown-inspired text specific to it. Click here jump into the [text syntax](https://mermaid-js.github.io/mermaid/#/n00b-syntaxReference).__"


More power to you and your team.
-Neil
2020-02-21 21:11:21 -08:00
Nacho 2cf8c4e37a Absolute URIs in readme images 2019-11-28 11:41:54 -05:00
Christian Klemm 1f8480f0af
Added npm badge (#1047) 2019-11-03 16:18:43 +01:00
Nacho 3674e27e0f
Reworked readme (#1045) 2019-11-01 13:38:00 -04:00
Knut Sveidqvist 97177dffd6
Updated coveralls badge 2019-10-30 19:54:47 +01:00
Knut Sveidqvist 8270469652
Update README.md 2019-10-30 19:44:53 +01:00
Knut Sveidqvist 5e6590a0f7
Fix of travis badge for new org 2019-10-30 19:40:02 +01:00
Knut Sveidqvist 61a3802494 Highlighting state diagrams and class diagrams in the readme 2019-10-19 17:45:56 +02:00
knsv 0157f665a3 Merge branch 'release/8.4.0' 2019-10-19 07:59:04 -07:00
Nacho dd68a7151f Removed gitter and added slack badge 2019-10-18 09:57:51 -04:00
Christian Klemm 8e1672568a
added preview builds to readme 2019-10-16 22:09:33 +02:00
Kolja Markwardt ecef0c78d2 reference the CONTRIBUTING.md in README 2019-10-15 22:22:01 +02:00
ashishjain0512 4ce523f33b
Merge pull request #973 from chris579/feature/963_class_annotations
Class diagram: annotations support
2019-10-08 12:56:49 +02:00
Knut Sveidqvist d9dda88164
Replaced info about linting 2019-10-06 09:02:07 +02:00
Christian Klemm 612df99c34
added tests + alt syntax 2019-10-04 23:49:58 +02:00
Christian Klemm 912e850db4
added grammar 2019-10-04 21:49:02 +02:00
Philipp A 1783ef501d
Fix accidental paste and code style in readme 2019-09-19 09:45:13 +02:00
knsv f98fa82134 Adding percy badge 2019-09-11 13:57:53 -07:00
David Pendray dbcd4f635e
Fix typos in README 2019-08-22 11:53:26 +01:00
Nathan Taylor ec67ee946a Typo in Readme
Fixed a typo in readme
2019-08-07 12:07:23 -07:00
Stan Hu 527aea9264 Fix securityLevel documentation
Instead of boolean values, only `strict` and `loose` should be
used.
2019-07-21 09:46:35 -07:00
Stan Hu e9f4ac7425 Fix typo: wich -> which 2019-07-21 09:16:47 -07:00
knsv 5dd392127f Release docs 2019-07-21 02:23:23 -07:00
Knut Sveidqvist cd907ff430
Update README.md 2019-06-29 16:15:53 +02:00
Knut Sveidqvist 724189e4ef
Update README.md 2019-06-29 16:14:31 +02:00
Knut Sveidqvist 7493031d11 Small doc change 2019-06-15 09:38:02 +02:00
Knut Sveidqvist e2dba9e9b8
Added job listing 2019-06-08 09:09:44 +02:00
Knut Sveidqvist c79fcf7ad5
Update README.md 2019-06-07 15:23:24 +02:00
Knut Sveidqvist 9191663a1a
Merge pull request #792 from jopapo/master
Added exclude weekdays to definition
2019-05-28 22:12:18 +02:00
0xflotus 7071cd7381
fixed diagrams 2019-03-18 11:48:18 +01:00
João Paulo Poffo 5a9c57ec0f Docs 2019-02-06 16:59:57 -02:00
Tyler Long 234d39cf96 Chrome browser is no longer a requirement for project setup 2018-03-15 23:46:22 +08:00
Tyler Long 003e5575b9 Setup code coverage 2018-03-10 08:54:28 +08:00
Tyler Long 048b39ae16 Remove coveralls 2018-03-09 14:23:37 +08:00
Tyler Long bb365ca1b5 Replace CodeClimate with coveralls 2018-03-09 14:01:53 +08:00
Tyler Long 8848203d90 Fix issues of last PR 2017-12-26 20:58:54 +08:00