V3

.github/workflows/codeql-analysis.yml

@@ -13,12 +13,12 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ "main" ]
+    branches: ["main"]
   schedule:
-    - cron: '19 6 * * 1'
+    - cron: "19 6 * * 1"
 
 jobs:
   analyze:
@@ -32,43 +32,42 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: ["javascript"]
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
         # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-
-        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
 
-
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+          # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+          # queries: security-extended,security-and-quality
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
 
-    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
-    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
-    # - run: |
-    #   echo "Run, Build Application using script"
-    #   ./location_of_script_within_repo/buildscript.sh
+      #   If the Autobuild fails above, remove it and uncomment the following three lines.
+      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
-      with:
-        category: "/language:${{matrix.language}}"
+      # - run: |
+      #   echo "Run, Build Application using script"
+      #   ./location_of_script_within_repo/buildscript.sh
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: "/language:${{matrix.language}}"

.github/workflows/test.yml

@@ -13,7 +13,7 @@ jobs:
     name: Test code
     strategy:
       matrix:
-        version: [18.x, 16.x, 14.x]
+        version: [19.x, 18.x, 16.x, 14.x]
     runs-on: ubuntu-latest
 
     steps:

README.md

@@ -1,62 +1,46 @@
-
 # Meowclient [![Test](https://github.com/webdev03/meowclient/actions/workflows/test.yml/badge.svg)](https://github.com/webdev03/meowclient/actions/workflows/test.yml)
-
-<h3 align="center"> A very cool library to connect to <a href="https://scratch.mit.edu/">Scratch.</a>  </h3>
 
-##  Getting Started
+<h3>A feature-rich library to connect to <a href="https://scratch.mit.edu/">Scratch.</a></h3>
+
+## Getting Started
 
 Follow the steps below:
 
-###  ⏳ Installation
+### ⏳ Installation
 
-Install Meowclient with this **Quickstart** command to install the latest version of meowclient in your `package.json`.
+If you run this install command you will get the latest version of meowclient in your `package.json`.
 
 ```bash
  npm install meowclient
 ```
 
-This command generates a brand new project with the default features.
-#### The library supports both CJS and ESM.
-
 ## Example (async)
 
 ```javascript
-import { ScratchSession } from "meowclient";
+import { ScratchSession, Profile } from "meowclient";
 const session = new ScratchSession();
 await session.init("user", "pass");
-const me = session.getProfile(session.username);
-// next line gets html and stores it so only 1 fetch request and no .init function - recreate the object to reset it
+const me = new Profile(session, session.username);
 console.log("My status is " + (await me.getStatus()));
 ```
 
-You might be able to use this **without even logging in by not running .init** on the session.
+Some features are available without logging in if you don't run the `session.init` function.
 
 ### The CJS way (if you still use it)
 
 ```js
 const { ScratchSession } = require("meowclient");
 const session = new ScratchSession();
 await session.init("user", "pass");
-const me = session.getProfile(session.username);
-// next line gets html and stores it so only 1 fetch request and no .init function - recreate the object to reset it
+const me = new Profile(session, session.username);
+// User.getStatus gets the status of the user, either "New Scratcher", "Scratcher" or "Scratch Team"
 console.log("My status is " + (await me.getStatus()));
 ```
 
-## Awesome features
-
-CJS **and** ESM support powered by tsup package!
-This is made with _typescript_ so you will also get .d.ts definition file and I will try my best to make good documentation! Some JSDoc comments are there too.
-
-## Why not _insert library name here_?
+## Note
 
-ESM support, typescript, comments parsing
-
-## Extra things
-
-I will not add any social actions to the library because then less chance of people getting banned from Scratch.
+Automating social actions such as loving, favouriting, commenting, or following users is not allowed in the Scratch Terms of Use so I won't add those features to meowclient unless you have a good reason, although if you know how to use the Scratch API you can definitely make your own fetch requests with the session.
 
 ## Thanks
 
 Thanks to [Scratchclient](https://github.com/CubeyTheCube/scratchclient) and Raihan142857 ([CubeyTheCube](https://github.com/CubeyTheCube)) for a lot of the login stuff!
-
-