Skip to content

Commit 53c2e5e

Browse files
committed
doc: fix README broken parts and use md over html tags
1 parent 3e0e213 commit 53c2e5e

File tree

1 file changed

+20
-55
lines changed

1 file changed

+20
-55
lines changed

README.md

Lines changed: 20 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,31 @@
11
<div align="center">
22
<!-- Title -->
3-
<h1>@material-table/core</h1>
3+
4+
# @material-table/core
5+
46
<!-- Subtitle : a fork of mbrn/material-table -->
5-
<h4>
6-
a fork of
7-
<code>
8-
<a
9-
target="_blank"
10-
href="https://material-table.com"
11-
>
12-
mbrn/material-table
13-
</a>
14-
</code>
15-
</h4>
7+
8+
**A fork of [`mbrn/material-table`](https://material-table.com)**
9+
1610
<!-- * Badges * -->
17-
<p>
18-
<section>
19-
<!-- build status -->
20-
<a href="https:/github.com/material-table-core/core/actions?query=workflow%3ABuild">
21-
<img
22-
title="Build"
23-
src="https:/github.com/material-table-core/core/workflows/Build/badge.svg?branch=master"
24-
>
25-
</a>
26-
<!-- publish status -->
27-
<!--
28-
<a href="https:/github.com/material-table-core/core/actions?query=workflow%3APublish">
29-
<img
30-
title="Publish"
31-
src="https:/github.com/material-table-core/core/workflows/Publish/badge.svg"
32-
>
33-
</a>
34-
-->
35-
<!-- npm package -->
36-
<a href="https:/www.npmjs.com/package/@material-table/core">
37-
<img
38-
title="npm_package"
39-
src="https:/badge.fury.io/js/%40material-table%2Fcore.svg"
40-
>
41-
</a>
42-
</section>
43-
<section>
44-
<!-- discord -->
45-
<a href="https:/discord.gg/uMr8pKDu8n">
46-
<img
47-
alt="Discord"
48-
src="https:/img.shields.io/discord/796859493412765697?label=discord"
49-
>
50-
</a>
51-
</section>
52-
</p>
11+
12+
[![build](https://github.com/material-table-core/core/workflows/Build/badge.svg?branch=master)](https://github.com/material-table-core/core/actions?query=workflow%3ABuild)
13+
[![publish](https://github.com/material-table-core/core/actions/workflows/publish.yml/badge.svg)](https://github.com/material-table-core/core/actions?query=workflow%3APublish)
14+
[![npm version](https://badge.fury.io/js/@material-table%2Fcore.svg)](https://www.npmjs.com/package/@material-table/core)
15+
[![discord](https://img.shields.io/discord/796859493412765697)](https://discord.gg/uMr8pKDu8n)
16+
5317
<!-- ^^^ end badges ^^ -->
54-
55-
Please review our [roadmap](https:/github.com/material-table-core/core/wiki/Roadmap)!
56-
57-
💾 [Installation](https://material-table-core.github.io/docs/#installation) 🎉 [Usage](https://material-table-core.github.io//docs/#basic-usage)
18+
19+
Please review our [roadmap](https://github.com/material-table-core/core/wiki/Roadmap)!
20+
21+
💾 [Installation](https://material-table-core.github.io/docs/#installation) 🎉 [Usage](https://material-table-core.github.io//docs/#basic-usage)
5822
[Why does this repo exist?](https://material-table-core.github.io/docs/about) 🚧 [Documentation](https://material-table-core.github.io/docs) ⚙️ [Demos](https://material-table-core.github.io/demos/)
23+
5924
</div>
6025

6126
# Sponsoring
6227

63-
We are now able to be sponsored via [Github Sponsors](https:/github.com/sponsors/material-table-core?o=esb) or [Open collective](https:/opencollective.com/material-table-core)!
28+
We are now able to be sponsored via [Github Sponsors](https://github.com/sponsors/material-table-core?o=esb) or [Open collective](https://opencollective.com/material-table-core)!
6429
So if you want to help us maintain this package, everything is appreciated.
6530

6631
# Contributing
@@ -69,6 +34,6 @@ Thanks for taking interest in contributing! :rocket: In being a community based
6934

7035
**Urgent items include**:
7136

72-
- Get rid of [`data-manager.js`](https:/github.com/material-table-core/core/blob/master/src/utils/data-manager.js) (which is a homegrown global state manager of sorts) and integrate [React context](https:/github.com/material-table-core/core/tree/context/src/store) via the `context` branch
73-
- Documentation over at [`material-table-core/website`](https:/github.com/material-table-core/website)
37+
- Get rid of [`data-manager.js`](https://github.com/material-table-core/core/blob/master/src/utils/data-manager.js) (which is a homegrown global state manager of sorts) and integrate [React context](https://github.com/material-table-core/core/tree/context/src/store) via the `context` branch
38+
- Documentation over at [`material-table-core/website`](https://github.com/material-table-core/website)
7439
- Implementing tests via Jest

0 commit comments

Comments
 (0)