Skip to content

Commit

Permalink
docs: adding content to the README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
Robiul H committed Apr 1, 2023
1 parent 4de69af commit a185b36
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 3 deletions.
43 changes: 41 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,41 @@
# baby-query
Baby Query is the custom implementation of the popular JavaScript library jQuery.
# Baby Query

Baby Query is a custom implementation of the popular JavaScript library jQuery.

## Features

- Simple and minimal: Just call the function with selector `$()` you are ready to do changes.

- Chainable methods: `$("div").css("width","200px").text("Hello world")`

- Better performance: Runs much faster and more efficiently.

## Methods

- Core:

- `.ready()`: Specify a function to execute when the DOM is fully loaded.

- CSS:

- `.css()`: Get the value of a computed style property for the first element in the set of matched elements or set one or more CSS properties for every matched element.

- Dom Manipulation:

- `.after()`: Insert content, specified by the parameter, after each element in the set of matched elements.

- `.append()`: Insert content, specified by the parameter, to the end of each element in the set of matched elements.

- `.attr()`: Get the value of an attribute for the first element in the set of matched elements also, Set one or more attributes for the set of matched elements.

- `.html()`: Get the HTML contents of the first element in the set of matched elements or set the HTML contents of every matched element.

- `.text()`: Get the combined text contents of each element in the set of matched elements, including their descendants, or set the text contents of the matched elements.

- Events

- `.on()`: Attach an event handler function for one or more events to the selected elements.

- `.trigger()`: Execute all handlers and behaviors attached to the matched elements for the given event type.

## Read the Documentation [here](robiulhr.github.io/baby-query/)
2 changes: 1 addition & 1 deletion docs/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ export default defineConfig({
]
},
{
text: 'Manupulation Methods',
text: 'Manipulation Methods',
collapsed: true,
items: [
{ text: '.after()', link: '/docs/manupulation/after' },
Expand Down

0 comments on commit a185b36

Please sign in to comment.