Skip to content

Commit

Permalink
Wrote Basic Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ElectronicsArchiver committed Oct 8, 2022
1 parent ff2c125 commit 6376236
Show file tree
Hide file tree
Showing 3 changed files with 134 additions and 2 deletions.
35 changes: 33 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,33 @@
# devRant
WIP

<br>

<div align = center>

<img
src = 'Resources/devRant.svg'
width = 120
/>

<br>

**[Deno]** *module for **[devRant]**'s API.*

<br>
<br>

[![Button Documentation]][Documentation]

</div>

<br>


<!----------------------------------------------------------------------------->

[Documentation]: https://deno.land/x/devrant
[devRant]: https://devrant.com/
[Deno]: https://deno.land/

<!---------------------------------[ Buttons ]--------------------------------->

[Button Documentation]: https://img.shields.io/badge/Documentation-00A1E9?style=for-the-badge&logoColor=white&logo=GitBook
55 changes: 55 additions & 0 deletions Resources/devRant.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 46 additions & 0 deletions Source/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@

## devRant API

*A wrapper for the **[devRant]** API.*

<br>

```JavaScript
import { User } from "https://deno.land/x/[email protected]/mod.ts";
```

<br>
<br>

## User Id

*Query for a users Id with their username.*

```JavaScript
const userId = await User.id('ElectroArchiver'); // 5703431
```

<br>
<br>

## User Content

*Query for a users profile content with a users Id.*

```JavaScript
const content = await DevRant.User.content({

// all , rants , upvoted , comments , favorites , collabs

content : 'all' ,

userId : 5703431
});
```

<br>


<!----------------------------------------------------------------------------->

[devRant]: https://devrant.com/

0 comments on commit 6376236

Please sign in to comment.