Skip to content

Commit 6376236

Browse files
Wrote Basic Documentation
1 parent ff2c125 commit 6376236

File tree

3 files changed

+134
-2
lines changed

3 files changed

+134
-2
lines changed

README.md

+33-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,33 @@
1-
# devRant
2-
WIP
1+
2+
<br>
3+
4+
<div align = center>
5+
6+
<img
7+
src = 'Resources/devRant.svg'
8+
width = 120
9+
/>
10+
11+
<br>
12+
13+
**[Deno]** *module for **[devRant]**'s API.*
14+
15+
<br>
16+
<br>
17+
18+
[![Button Documentation]][Documentation]
19+
20+
</div>
21+
22+
<br>
23+
24+
25+
<!----------------------------------------------------------------------------->
26+
27+
[Documentation]: https://deno.land/x/devrant
28+
[devRant]: https://devrant.com/
29+
[Deno]: https://deno.land/
30+
31+
<!---------------------------------[ Buttons ]--------------------------------->
32+
33+
[Button Documentation]: https://img.shields.io/badge/Documentation-00A1E9?style=for-the-badge&logoColor=white&logo=GitBook

Resources/devRant.svg

+55
Loading

Source/README.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
2+
## devRant API
3+
4+
*A wrapper for the **[devRant]** API.*
5+
6+
<br>
7+
8+
```JavaScript
9+
import { User } from "https://deno.land/x/devrant@0.1.0/mod.ts";
10+
```
11+
12+
<br>
13+
<br>
14+
15+
## User Id
16+
17+
*Query for a users Id with their username.*
18+
19+
```JavaScript
20+
const userId = await User.id('ElectroArchiver'); // 5703431
21+
```
22+
23+
<br>
24+
<br>
25+
26+
## User Content
27+
28+
*Query for a users profile content with a users Id.*
29+
30+
```JavaScript
31+
const content = await DevRant.User.content({
32+
33+
// all , rants , upvoted , comments , favorites , collabs
34+
35+
content : 'all' ,
36+
37+
userId : 5703431
38+
});
39+
```
40+
41+
<br>
42+
43+
44+
<!----------------------------------------------------------------------------->
45+
46+
[devRant]: https://devrant.com/

0 commit comments

Comments
 (0)