Skip to content

Commit 8519e9f

Browse files
authored
Added Readme
1 parent 917d7d8 commit 8519e9f

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Tajweed
2+
*Tajweed is [npm](https://en.wikipedia.org/wiki/Npm_(software)) package for Tajweed and Buck*
3+
## Quran Tools for Parsing Tajweed and Buck
4+
5+
The npm package is to be used with the [AlQuran.cloud](https://alquran.cloud/api) and [GlobalQuran.com](http://docs.globalquran.com/API:Data/Quran_List) APIs. They are made available so you may get the most out of the APIs.
6+
7+
## Installation
8+
9+
Use the package manager [npm](https://www.npmjs.com/) to install Tajweed.
10+
11+
```bash
12+
npm install tajweed
13+
#or
14+
yarn add tajweed
15+
```
16+
17+
## Usage
18+
19+
```javascript
20+
const Tajweed = require('tajweed').Tajweed
21+
22+
let string = "۞ ٱللَّهُ نُورُ [h:9421[ٱ][l[ل]سَّمَ[n[ـٰ]و[n[َٲ]"; //
23+
let parseTajweed = new Tajweed()
24+
let parseString = parseTajweed.parse("string",true)
25+
console.log(parseString)
26+
```
27+
28+
```javascript
29+
import './tajweed.css'
30+
import tajweed, {Tajweed} from 'tajweed';
31+
32+
function App() {
33+
let string = "۞ ٱللَّهُ نُورُ [h:9421[ٱ][l[ل]سَّمَ[n[ـٰ]و[n[َٲ]"; //
34+
let parseTajweed = new Tajweed()
35+
let parseString = parseTajweed.parse("string",true)
36+
37+
38+
39+
return (
40+
<div dangerouslySetInnerHTML={{__html:parseString )}}></div>
41+
42+
);
43+
}
44+
45+
export default App;
46+
```
47+
48+
## Contributing
49+
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
50+
51+
Please make sure to update tests as appropriate.
52+
53+
## License
54+
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)