Skip to content

Update README links/installation/typos #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 10, 2024
Merged

Update README links/installation/typos #11

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a176175
Update README.md
simondelphia Jun 28, 2023
619d0f0
Update README.md
simondelphia Jun 28, 2023
51d2691
Fix typos in markdown imports in readmes
simondelphia Jul 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# React Native Markdown Display [![npm version](https://badge.fury.io/js/react-native-markdown-display.svg)](https://badge.fury.io/js/react-native-markdown-display) [![Known Vulnerabilities](https://snyk.io/test/github/iamacup/react-native-markdown-display/badge.svg)](https://snyk.io/test/github/iamacup/react-native-markdown-display)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't know if you'd want to change the snyk security vulnerability thing too…

# React Native Markdown Display [![npm version](https://badge.fury.io/js/@ronradtke%2Freact-native-markdown-display.svg)](https://badge.fury.io/js/@ronradtke%2Freact-native-markdown-display) [![Known Vulnerabilities](https://snyk.io/test/github/iamacup/react-native-markdown-display/badge.svg)](https://snyk.io/test/github/iamacup/react-native-markdown-display)

It a 100% compatible CommonMark renderer, a react-native markdown renderer done right. This is __not__ a web-view markdown renderer but a renderer that uses native components for all its elements. These components can be overwritten and styled as needed.

Expand All @@ -10,12 +10,12 @@ This is intended to be a replacement for react-native-markdown-renderer, with a

#### Yarn
```npm
yarn add react-native-markdown-display
yarn add @ronradtke/react-native-markdown-display
```

#### NPM
```npm
npm install -S react-native-markdown-display
npm install -S @ronradtke/react-native-markdown-display
```

### Get Started
Expand All @@ -24,7 +24,7 @@ npm install -S react-native-markdown-display
import React from 'react';
import { SafeAreaView, ScrollView, StatusBar } from 'react-native';

import Markdownfrom '@ronradtke/react-native-markdown-display';
import Markdown from '@ronradtke/react-native-markdown-display';

const copy = `# h1 Heading 8-)

Expand Down Expand Up @@ -847,7 +847,7 @@ Think of the implementation like applying styles in CSS. changes to the `body` e
import React from 'react';
import { SafeAreaView, ScrollView, StatusBar } from 'react-native';

import Markdownfrom '@ronradtke/react-native-markdown-display';
import Markdown from '@ronradtke/react-native-markdown-display';

const copy = `
This is some text which is red because of the body style, which is also really small!
Expand Down Expand Up @@ -910,7 +910,7 @@ Styles are used to override how certain rules are styled. The existing implement
import React from 'react';
import { SafeAreaView, ScrollView, StatusBar, StyleSheet } from 'react-native';

import Markdownfrom '@ronradtke/react-native-markdown-display';
import Markdown from '@ronradtke/react-native-markdown-display';

const styles = StyleSheet.create({
heading1: {
Expand Down Expand Up @@ -984,7 +984,7 @@ Rules are used to specify how you want certain elements to be displayed. The exi
import React from 'react';
import { SafeAreaView, ScrollView, StatusBar, Text } from 'react-native';

import Markdownfrom '@ronradtke/react-native-markdown-display';
import Markdown from '@ronradtke/react-native-markdown-display';

const rules = {
heading1: (node, children, parent, styles) =>
Expand Down Expand Up @@ -1093,7 +1093,7 @@ It is possible to overwrite this behaviour in one of two ways:
import React from 'react';
import { SafeAreaView, ScrollView, StatusBar } from 'react-native';

import Markdownfrom '@ronradtke/react-native-markdown-display';
import Markdown from '@ronradtke/react-native-markdown-display';

const copy = `[This is a link!](https://github.com/iamacup/react-native-markdown-display/)`;

Expand Down Expand Up @@ -1145,7 +1145,7 @@ Something like this with `yourCustomHandlerFunctionOrLogicHere`:
import React from 'react';
import { SafeAreaView, ScrollView, StatusBar, Text } from 'react-native';

import Markdownfrom '@ronradtke/react-native-markdown-display';
import Markdown from '@ronradtke/react-native-markdown-display';

const copy = `[This is a link!](https://github.com/iamacup/react-native-markdown-display/)`;

Expand Down